Documentation Strategy

Documentation Key Summary

Documentation involves the transfer of information.

The top open documentation priorities are:

• Quality Content

• Quick Navigation

• Ease of Editing

Final Product Release Documentation Template for Book/PDF/eBook

This is what a final product release document should contain.

Understand It

This section is a holistic story of the tool

1. What Is It Used For?
   • Problems the machine addresses
   • How the machine improves our lives
2. How Does It Work?
   • What are the physics behind this machine?
   • What is the rationale behind the machine’s design?
3. History Of This Tool
   • Social History
   • Inventor Crediting

Build It

Step by step breakdown of how to manufacture this tool.

1. Overview of entire process

   This is useful for a remote FabLab to know what exactly to invest in before entering the enterprise.

   • All tools needed
     • Sourcing
   • All materials needed
     • Sourcing
   • All proficiencies needed
     • Links to Wikipedia or other information source
2. Chronological Process Breakdown

   Standard format operations manual similar to those included with consumer and professional devices. Includes images and videos for each operation

   • Tools Needed
   • Materials Needed
   • Step-by-step manufacture instructions

GREEN TEXT: Documenter decides whether this is necessary depending on specific process

Possible keywords for process breakdown

• Making Components (Fabrication?)
• Assembling Components (Assembly?)
• Painting & Finishing
• Material
• Electronic
• Hydraulic
• Biological
• Neurological
• Quantum
• Software

Use It

Standard format operations manual similar to those included with consumer and professional devices. Includes images and videos for each operation

1. Operations Manuals
   • Operations Manuals Keywords
     1. Advanced User
     2. Basic User

Troubleshoot It

Known issues and community base for troubleshooting and repairs.

1. Known Symptoms and their causes in a wiki (any logged-in user can edit)
2. Community Discussion Page (Forum style)
   • Topics -> Threads -> Discussions
   • Community Q/A Page
   • A Question -> Multiple answer format with best answer voting system

Documentation Process

TBD