Show/Hide Toolbars

Online Help Style Guide

Navigation: » No topics above this level «

Introduction to online documentation guidelines

Scroll Prev Top Next More

This style guide helps insure that online documentations for software is clear, concise, and consistent.  This guide covers the organization, writing style, markup, and accessibility.  This guide is provided to technical writers to support the objectives for technical documentation.

 

The main purpose of this guide is to help insure that online documentation supports the objectives of good online documentation.  A second purpose is to help insure that the documentation follows generally accepted rules for grammar, punctuation, and style.  A third objective is to help insure that the documentation is consistent.  In some cases, this guide recommends specific practices and techniques.  These recommendations are made not because they are the only correct way, but because following them produces consistency in style and formatting.

 

Related Information

  Objectives of Good Online Documentation