-
Epic
-
Resolution: Done
-
Major
-
None
-
None
This is a 3scale documentation effort to improve the content by making the following kinds of updates:
NB: The issue listed in this Epic are for the 3scale Docs team only. We do not want to create issues that require SME/QE input.
Note also the Release Notes are not included. This is because at the moment there is a CCS-wide initiative to improve and make the Release Notes consistent across docs.
Reference: Peer review checklist
Language
- Checking for consistency
- Use of gerunds
- Grammar and Spelling Corrections
- Correct word usage and entity naming
- Correct use of acronyms and abbreviations
- Terms and constructions
Style
- Passive voice
- Tense
- Titles
- Numbers
- Formatting
Minimalism
- Customer focus and action orientation
- Scannability/Findability
- Overly long sentences
- Conciseness (no fluff)
Usability
- Content
- Accessibility
- Links
- Visual continuity
Structure
Modularization
dfenness@redhat.com and rhn-support-lcavalle will drive this effort separately, in parallel to the above.
- Structure meets modular guidelines
- A logical flow of information
- User stories