Editorial Style
- Introduction
- Break up text into segments: Web readers skim text to form an overview or to locate specific information. Break content into easy-to-skim segments, and use headings to identify the subject of each segment.
- Start sentences, headings, and links with keywords: Skimming is more efficient when editorial landmarks begin with keywords. Put important words or phrases at the beginning of sentences, headings, and links.
- Adopt a writing style that is clear and to the point: Web readers are goal-oriented and get bogged down by lengthy and unnecessary explanations and instructions. Be concise and factual; avoid meaningless prose.
- Use appropriate language and terminology: Users benefit from a writing style that is geared for their knowledge level. Adopt an appropriate writing style and vocabulary, and apply it consistently.
- Keep content current and links functional: Out-of-date content and broken links put into question the overall reliability of a site. Revisit content on a regular basis to validate and repair links and to update or remove content.
- Mark up language changes within a document: Software can read documents more accurately when language changes are identified. Indicate the primary document language, and use markup to mark language changes.
- Identify and describe abbreviations and acronyms: Software can provide clarifying information for abbreviations and acronyms. For improved screen reader access, use style sheets to indicate whether these elements should be spoken or spelled out.
- Provide a print option for lengthy documents: Some people prefer to print longer documents for offline reading. Provide a single-page printing version for documents that are likely to be printed.