Technical Document Re-working Group/Resources

Overview edit

This page provides a list of ideas and links to sources about various aspects of technical documentation.

What is Technical Writing edit

Creating a technical documentation plan/strategy edit

  • Gives shape to your project
  • Purpose -- For what reason are you documenting this thing
  • Deliverables -- The documents you plan to deliver
  • Requirements (including regulatory if applicable)-- High level needs that the documentation should meet
  • Audience -- Who is this for? Envision this as a real group.
  • Include a last modified date on documentation (and description of changes when possible)

Evaluating technical documentation and measuring success edit

Requirements edit

Understanding APIs and how they work edit

Simple API Documentation Template and Examples edit

Documentation writing edit

Documentation Tools edit

Examples of good work edit

Analysis of our docs edit

Additional links edit