-
Style Guide
- Introduction
- General Writing Principles
- Clarity and Conciseness
- Tone and Voice
- Consistency
- Inclusivity and Accessibility
- Timeless Documentation
- Global Audience
- Text Formatting
- Bold, Italics, and Underlining
- Capitalisation Rules
- Code Formatting
- Dates and Times
- Special Characters
- Documentation Structure
- Document Layout
- Section Headers and Subheaders
- Paragraph Structure
- Bullet Points
- Numbered Lists
- Nested Lists
- Style and Grammar Guidelines
- Sentence Structure
- Active vs Passive Voice
- Punctuation and Spacing
- Use of Abbreviations and Acronyms
- Spelling and Word Usage
- Terminology and Language
- Links and References
- Images and Graphics
- Image Selection Criteria
- Image Formatting and Placement
- Captions and Alt Text
- File Naming Conventions
- Accessibility Considerations
- Notes, Tips, and Warnings
- Review and Approval Process