Documentation Strategy: Difference between revisions
| Line 17: | Line 17: | ||
We are looking for: | We are looking for: | ||
*Ease | *Ease to download entire project contents to a local directory | ||
*Ease of | *Ease of navigating the local content | ||
*Ease of | *Ease of editing the local content | ||
We need to consider a stand-alone program that is executable from a locally pulled project repository. This stand-alone program should allow ease of local content navigation as well as ease of local editing. | *Ease of syncing with project repositories | ||
We need to consider a stand-alone program that is executable from a locally pulled project repository. This stand-alone program should allow ease of local content navigation as well as ease of local editing. Downloading the repository to start with as well as syncing the local contents would then be considered as functions of another program more focused on file downloading and uploading. | |||
=Final Product Release Documentation Template for Book/PDF/eBook= | =Final Product Release Documentation Template for Book/PDF/eBook= | ||
Revision as of 06:02, 4 July 2012
Documentation Key Summary
Documentation involves the transfer of information.
The top open documentation priorities are:
- Quality Content
- Quick Navigation
- Ease of Editing
Documentation Platform Summary
Currently, we use a combination of the Wikimedia platform and Github.
We are looking for:
- Ease to download entire project contents to a local directory
- Ease of navigating the local content
- Ease of editing the local content
- Ease of syncing with project repositories
We need to consider a stand-alone program that is executable from a locally pulled project repository. This stand-alone program should allow ease of local content navigation as well as ease of local editing. Downloading the repository to start with as well as syncing the local contents would then be considered as functions of another program more focused on file downloading and uploading.
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