Style Guide

• Introduction
  • Confidentiality and Use
  • Highlights
  • Purpose of the Guide
  • Scope and Audience
• General Writing Principles
  • Clarity and Conciseness
  • Consistency
  • Global Audience
  • Inclusivity and Accessibility
  • Timeless Documentation
  • Tone and Voice
• Text Formatting
  • Bold, Italics, and Underlining
  • Capitalisation Rules
  • Code Formatting
  • Dates and Times
  • Special Characters
• Documentation Structure
  • Bullet Points
  • Document Layout
  • Nested Lists
  • Numbered Lists
  • Paragraph Structure
  • Section Headers and Subheaders
• Style and Grammar Guidelines
  • Active vs Passive Voice
  • Punctuation and Spacing
  • Sentence Structure
  • Spelling and Word Usage
  • Use of Abbreviations and Acronyms
• Terminology and Language
  • Approved Terminology
  • Language Variants (American/British English)
  • Word List (Technical Terms)
• Links and References
  • Hyperlinking Best Practices
  • Internal vs. External Links
  • References and Citations
• Images and Graphics
  • Accessibility Considerations
  • Captions and Alt Text
  • File Naming Conventions
  • Image Formatting and Placement
  • Image Selection Criteria
• Notes, Tips, and Warnings
  • Differentiating Tips from Warnings
  • Formatting and Placement
  • When to Use Notes
• Review and Approval Process
  • Drafting Process
  • Final Approval and Publication
  • Peer Review Guidelines
• Updates and Maintenance
  • Archiving Outdated Documentation
  • Periodic Reviews and Updates
  • Version Control
• Tools and Resources
  • Helpful Links and Tutorials
  • Style Guide References
  • Writing Tools and Software