Technical Document Re-working Group/Resources

OverviewEdit

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

What is Technical WritingEdit

http://www.stc-psc.org/what-is-technical-writing/

Creating a technical documentation plan/strategyEdit

  • 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 successEdit

RequirementsEdit

Understanding APIs and how they workEdit

Simple API Documentation Template and ExamplesEdit

Documentation writingEdit

Documentation ToolsEdit

Examples of good workEdit

Analysis of our docsEdit

Additional linksEdit