Technical Writers - Methodology

Methodology

To create a technical document, a technical writer must understand the audience, the purpose, and the product. They also gather information by studying existing material, interviewing SMEs, and/or actually using the products to be documented, as well as studying the audience to learn their needs and technical understanding level.

A technical publication's development life cycle consists of five distinct phases, which are coordinated with the overall product development plan:

• Phase 1: Information gathering and planning
• Phase 2: Content specification
• Phase 3: Content development and implementation
• Phase 4: Production
• Phase 5: Evaluation

Well-written technical documents usually follow formal standards or guidelines. Technical documentation comes in many styles and formats, depending on the medium and subject area. Printed and online documentation may differ in various ways, but still adhere to largely identical guidelines for prose, information structure, and layout. Usually, technical writers follow formatting conventions described in a standard style guide. In the US, technical writers often use the Chicago Manual of Style (CMS). Many companies have internal corporate style guides that cover specific corporate issues such as logo use, branding, and other aspects of corporate style. The Microsoft Manual of Style for Technical Publications is typical of these.

Engineering projects, particularly defense or aerospace related projects, often follow national and international documentation standards—such as ATA100 for civil aircraft or S1000D for civil and defense platforms.