Rounded_StyleGuide
  • Introduction
  • About the style guide
    • Introduction
    • Highlights
  • General rules
    • Voice and tone
    • Accessible content
  • Language and Grammar
    • Abbreviations
    • Active voice
    • Articles (A, An, The)
    • Cross-references
    • Spelling
    • Terminology
  • Content guidelines
    • Use images and animated gifs
    • Tell a story
    • Lists
    • Tables
Powered by GitBook
On this page

Was this helpful?

  1. General rules

Accessible content

Most of the principles that apply to good technical documentation also apply to accessible technical documentation:

  • Use correct grammar and punctuation.

  • Use active voice and present tense.

  • Write clear, simple sentences.

  • Be consistent.

  • Avoid jargon, slang, and the like.

  • Beware of dangling modifiers.

  • Use the relative pronoun "that" where you might otherwise omit it.

  • Use the simplest terminology.

  • Use colours judiciously. Keep in mind that some colour-blind people cannot tell red from green.

    Make sure that your text colour contrasts sufficiently with your background colour.

PreviousVoice and toneNextAbbreviations

Last updated 5 years ago

Was this helpful?