Documentation Strategy
Jump to navigation
Jump to search
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
- What Is It Used For?
- Problems the machine addresses
- How the machine improves our lives
- How Does It Work?
- What are the physics behind this machine?
- What is the rationale behind the machine’s design?
- History Of This Tool
- Social History
- Inventor Crediting
Build It
Step by step breakdown of how to manufacture this tool.
- 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
- 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
- Operations Manuals
- Operations Manuals Keywords
- Advanced User
- Basic User
- Operations Manuals Keywords
Troubleshoot It
Known issues and community base for troubleshooting and repairs.
- Known Symptoms and their causes in a wiki (any logged-in user can edit)
- 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