Bug 636645

Summary: Create doc style guide
Product: [Other] RHQ Project Reporter: Deon Ballard <dlackey>
Component: DocumentationAssignee: Deon Ballard <dlackey>
Status: CLOSED WONTFIX QA Contact: Mike Foley <mfoley>
Severity: medium Docs Contact:
Priority: low    
Version: unspecifiedCC: ccrouch
Target Milestone: ---   
Target Release: ---   
Hardware: All   
OS: Linux   
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2013-08-09 13:31:00 EDT Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---

Description Deon Ballard 2010-09-22 15:29:35 EDT
There needs to be a style guide for writing new user and dev docs for RHQ/JON. The style guide should cover:
 * Doc outlines for different doc types
 * Grammar and sentence structure
 * Tone and style

The style guide should include real examples of both good and bad engineering docs for comparison.
Comment 1 Deon Ballard 2013-08-09 13:31:00 EDT
I just don't have the time at the moment to tackle this. I'll address it later, I hope.