Open Source Documentation Module/How to document

▼This page is part of a project funded by Global Innovation Gathering

It is currently not open edit.

Documentation is not only a thing that you do, but a process that takes place during the whole project’s lifecycle. We will explore both the input and the output: how to capture information and where to host it.

Define the right documentation practices to maintain for the project’s duration.

Participants will:

• Understand how and when documentarians collect information.
• Identify parts of their own project that can be documented.
• Create a simple documentation checklist with regular activities, and tools to use.

• Kermish-Allen, Ruth. “Designing for Online Collaborations and Local Environmental Action In Citizen Science: A Multiple Case Study.” Antioch University Dissertations & Theses, January 1, 2016. https://aura.antioch.edu/etds/294
• Sánchez, Francisco. “How to Document - Fablab BCN Local Documentation.” Accessed November 4, 2026. https://learn.fablabbcn.org/guides/workflows/documentation/
• Kanthatham, Rico, and Georg Tremmel. “Fab Academy Documentation: Purpose, Technique & Tools.” FabLab Kamakura, Kamakura, Japan, January 18, 2023. https://fablabkamakura.fabcloud.io/FabAcademy/support-documents/documentation/
• OPEN-NEXT. OPEN-NEXT/WP2.3 Guideline and Template for Documentation of OSH Design-Reuse. January 12, 2022, Released August 26, 2022. https://github.com/OPEN-NEXT/WP2.3-Guideline-and-template-for-documentation-of-OSH-design-reuse
• The Memex Method – Pluralistic: Daily Links from Cory Doctorow. May 9, 2021. https://pluralistic.net/2021/05/09/the-memex-method/
• Appleton, Maggie. “A Brief History & Ethos of the Digital Garden.” June 10, 2020. https://maggieappleton.com/garden-history

• oeadmin. “Upverter Proposes the Hardware Product Canvas.” Open Electronics, November 17, 2013. https://www.open-electronics.org/upverter-proposes-the-hardware-product-canvas/
• Colomb, Julien. “Hardware Documentation Guide.” August 15, 2025. https://open-make.github.io/Hardware-template-guide/
• Velis, Emilio. “Porting Decisions Flowchart.” Appropedia, the Sustainability Wiki. Accessed November 4, 2026. https://www.appropedia.org/File:Porting_decisions.png
• Open Source Ecology. “Daily Log of Tasks.” Wiki. Accessed November 4, 2026. https://wiki.opensourceecology.org/index.php?title=Daily_Log_of_Tasks
• Open Source Ecology. “Development Spreadsheet Template.” Accessed November 4, 2026. https://wiki.opensourceecology.org/wiki/Development_Spreadsheet_Template#Simple_Template
• Appropedia, the Sustainability Wiki. “Help:Video Documentation.” Accessed November 4, 2026. https://www.appropedia.org/Help:Video_documentation

• Domestika English. DIY Tutorial: How to Make a Notepad at Home. 2026. https://www.youtube.com/watch?v=2ExqNBktBAk
• Chemistry with Mr. B. Lab Notebook Setup. 2022. https://www.youtube.com/watch?v=dnd9Qiz6Z40

• https://converseen.fasterland.net/
• https://github.com/hexplor/nautilus-imageconverter
• https://www.shutterencoder.com/
• https://handbrake.fr/
• https://nextcloud.com/
• https://www.digikam.org/
• https://www.audacityteam.org/
• https://ffmpeg.org/

• “Discover | Hackaday.Io.” Accessed November 4, 2026. https://hackaday.io/discover
• Fab Academy. “Fab Academy.” Accessed November 4, 2026. https://fabacademy.org/
• Appropedia, the Sustainability Wiki. “Welcome to Appropedia.” Accessed November 4, 2026. https://www.appropedia.org/Welcome_to_Appropedia