--- title: Software Documentation description: Software documentation is the practice of writing clear guides, API references, and system diagrams for developers and users. You will understand how to explain technical concepts, document codebases, and maintain accessible, up-to-date technical resources. category: programming-tech subcategory: software-architecture difficulty: beginner, intermediate, advanced url: /subject/software-documentation --- # Software Documentation Software documentation is the practice of writing clear guides, API references, and system diagrams for developers and users. You will understand how to explain technical concepts, document codebases, and maintain accessible, up-to-date technical resources. ## Available Resources 2 Books • 4 Websites ## Websites ### 1. Architecture Decision Records (ADR) The community hub for architecture decision records: templates, tooling, and worked examples. Readers come away able to capture a design decision with its context, options considered, and consequences in a short versioned file alongside the code. **Difficulty:** Beginner | **Price:** Free **Link:** https://adr.github.io/ **Tags:** architecture decision records, software architecture, technical documentation, engineering practices ### 2. Diátaxis Framework Daniele Procida's model splits technical documentation into four distinct modes—tutorials, how-to guides, reference, and explanation—each with its own purpose and voice. After reading, you can diagnose why a docs set feels muddled and restructure it. **Difficulty:** Beginner | **Price:** Free **Link:** https://diataxis.fr/ **Tags:** documentation framework, diataxis, technical writing, information architecture ### 3. writethedocs.org Write the Docs is a community resource hub for software documentation, offering practical guidance, articles, and talks on writing, structuring, and maintaining project docs, plus information about their conferences and events. **Difficulty:** Intermediate | **Language:** English | **Price:** Free **Link:** https://writethedocs.org **Tags:** websites, technology-computer-science, software-architecture ### 4. idratherbewriting.com I’d Rather Be Writing is a blog and resource site about software documentation and technical writing. It offers articles on API docs, user guides, information architecture, content strategy, and practical tips for documentation teams. **Difficulty:** Intermediate | **Language:** English | **Price:** Free **Link:** https://idratherbewriting.com **Tags:** websites, technology-computer-science, software-architecture ## Podcasts ### 1. API The Docs Podcast **Author:** Laura Vass, Anett Pozsár Interview podcast from the API The Docs community, where technical writers, developer advocates and portal teams discuss API reference documentation, developer portal design, docs-as-code workflows and measuring documentation quality. Listeners gain practical ideas for planning and improving developer-facing documentation. **Difficulty:** Beginner | **Language:** en | **Price:** Free **Link:** https://apithedocs.org/ **Tags:** api-documentation, developer-portals, technical-writing, docs-as-code, developer-experience ### 2. Write the Docs Podcast **Author:** Write the Docs Podcast Write the Docs is a series of conferences, local meetups, and Slack groups focused on all things related to software documentation. We consider everyone who cares about communication, documentation, and their users to be a member of our community. This can be programmers, tech writers, customer support, marketers, and anyone else who wants people to have great experiences with software. This podcast is focused on topics discussed and debated within this community. **Difficulty:** Beginner | **Language:** en-us | **Price:** Free **Link:** https://podcast.writethedocs.org **Tags:** technical writing, documentation practice, docs community, developer experience ## Books ### 1. Docs for Developers **Author:** Jared Bhatti, Zachary Sarah Corleissen, Jen Lambourne, David Nunez, Heidi Waterhouse Five practitioners from Google, Stripe, and elsewhere follow a fictional product team through planning, drafting, editing, publishing, and measuring documentation. You finish with a repeatable workflow for shipping developer docs and deciding what to write next. **Difficulty:** Intermediate | **Language:** English | **Price:** Paid **Link:** https://www.amazon.com/dp/1484272161?tag=edmonddante07-20 **Tags:** books, technology-computer-science, software-architecture ### 2. Every Page is Page One **Author:** Mark Baker Baker argues that readers arrive at documentation mid-search rather than at page one, and shows how to write self-contained topics that establish their own context and link outward. Aimed at writers moving beyond linear manuals. **Difficulty:** Intermediate | **Language:** English | **Price:** Paid **Link:** https://www.amazon.com/dp/1937434281?tag=edmonddante07-20 **Tags:** books, technology-computer-science, software-architecture --- *This content is part of Dantes.io - Your Treasure Map to Knowledge* *Curated by humans at Dantes.io. Personal study use welcome; republishing this curation requires permission (team@dantes.io).* View this page online: https://dantes.io/subject/software-documentation