Bug 636645 – Create doc style guide

Bug 636645 - Create doc style guide

Summary:	Create doc style guide

Status:	CLOSED WONTFIX

Aliases:	None

Product:	RHQ Project
Classification:	Other
Component:	Documentation (Show other bugs)
Sub Component:
Version:	unspecified
Hardware:	All Linux

Priority	low Severity medium (vote)
Target Milestone:	---
Target Release:	---
Assigned To:	Deon Ballard
QA Contact:	Mike Foley
Docs Contact:

URL:
Whiteboard:
Keywords:

Depends On:
Blocks:
	Show dependency tree / graph

Reported:	2010-09-22 15:29 EDT by Deon Ballard
Modified:	2013-08-09 13:31 EDT (History)
CC List:	1 user (show)

See Also:
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:	---

Attachments	(Terms of Use)
Add an attachment (proposed patch, testcase, etc.)

Groups: None (edit)

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.

Note You need to log in before you can comment on or make changes to this bug.