Bug 636645 - Create doc style guide
Summary: Create doc style guide
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: RHQ Project
Classification: Other
Component: Documentation
Version: unspecified
Hardware: All
OS: Linux
low
medium
Target Milestone: ---
: ---
Assignee: Deon Ballard
QA Contact: Mike Foley
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2010-09-22 19:29 UTC by Deon Ballard
Modified: 2013-08-09 17:31 UTC (History)
1 user (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2013-08-09 17:31:00 UTC
Embargoed:

Attachments (Terms of Use)

Description Deon Ballard 2010-09-22 19:29:35 UTC 
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 17:31:00 UTC 
I just don't have the time at the moment to tackle this. I'll address it later, I hope.
Note You need to log in before you can comment on or make changes to this bug.