OSE Documentation Philosophy: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
OSE's documentation philosophy is such that when we document, we enable many aspects: | OSE's documentation philosophy is such that when we document, we enable many aspects: | ||
#[[CAD-BOM-Build]] | #[[CAD-BOM-Build-Data]] | ||
#Development of FreeCAD workbenches | #Development of FreeCAD workbenches | ||
#Development of User Guides | #Development of User Guides | ||
| Line 11: | Line 11: | ||
#Enabling rapid learning within groups, within divisions of OSE, and outside of OSE | #Enabling rapid learning within groups, within divisions of OSE, and outside of OSE | ||
#Documenting design rationales and choices for the purpose of creating [[Design Guides]] | #Documenting design rationales and choices for the purpose of creating [[Design Guides]] | ||
#Developing workflows, ergonomics, and capturing data. | |||
#And many others. | #And many others. | ||
All together, | |||
All together, all of the above should be captured in realtime crowd editable, open access documents that evolve constantly. See [[Work Doc]]. Each design, project, and area of endeavor shoudl | |||
Latest revision as of 19:36, 13 June 2023
Philosophy guides strategy and tactics.
OSE's documentation philosophy is such that when we document, we enable many aspects:
- CAD-BOM-Build-Data
- Development of FreeCAD workbenches
- Development of User Guides
- Development of Maintenance and Troubleshooting manuals
- Publication of books on various topics of open source ecology
- Creation of Cheatsheets for builds
- Time-binding by enabling others to study, use, improve documentation, focused on creating new economic possibilities
- Enabling rapid learning within groups, within divisions of OSE, and outside of OSE
- Documenting design rationales and choices for the purpose of creating Design Guides
- Developing workflows, ergonomics, and capturing data.
- And many others.
All together, all of the above should be captured in realtime crowd editable, open access documents that evolve constantly. See Work Doc. Each design, project, and area of endeavor shoudl