Jump to content

Open Source Documentation Module/Why we document

From Appropedia

Documentation is the practice of making evidence accessible and understandable. The process of documenting is, therefore, not just an ongoing collection of descriptive texts but the assembly of resources that will serve future users as they engage with a project in the past. Or, in the words of Damian Conway, documentation is a love letter for a future self (and as we argue, to others as well).

Learning objective

[edit | edit source]

To frame documentation by considering implicit assumptions about the project and turning them into a list of explicit documentation requirements.

Desired outcomes

[edit | edit source]

Participants will:

  • Identify the evidence of their project to show to a broader audience.
  • Plan their documentation by outlining the project’s implicit assumptions and useful explicit elements.
mqdefault.jpgYouTube_icon.svg

Readings

[edit | edit source]

Tools

[edit | edit source]
Page data
License CC-BY-SA-4.0
Language English (en)
Related 0 subpages, 5 pages link here
Views 0 page views (analytics)
Created October 20, 2026 by Paola María Moreno
Last edit November 11, 2026 by StandardWikitext bot
Cookies help us deliver our services. By using our services, you agree to our use of cookies.