Informal Documentation

Informal documentation refers to unstructured, non-official written materials that capture knowledge, processes, or decisions in a development context, such as README files, code comments, wikis, or chat logs. It serves to communicate information quickly and flexibly within teams, often complementing formal documentation. This approach emphasizes practicality and accessibility over strict formatting or approval processes.

Also known as: Unofficial Documentation, Ad-hoc Documentation, Lightweight Documentation, Internal Docs, Team Documentation

Why learn Informal Documentation?

Developers should use informal documentation to facilitate team collaboration, onboard new members, and document ad-hoc decisions or code rationale that don't fit into formal specs. It's particularly valuable in agile environments, open-source projects, or when rapid iteration makes formal documentation impractical, as it reduces knowledge silos and improves code maintainability.

Learning Resources

• docs: GitHub Guides: Mastering Markdown
• tutorial: Write the Docs: A Guide to Documentation Best Practices
• course: Google Technical Writing Courses
• tutorial: The Art of Readme: Best Practices for README Files
• docs: Documentation as Code: Principles and Tools