> Markdown version of [/playlists/documentation](https://www.wearedevelopers.com/playlists/documentation). Every page supports `.md` or `Accept: text/markdown`. Links point to the HTML versions so they work for humans too. Agent guide: [/agents.md](https://www.wearedevelopers.com/agents.md). --- # Playlist: Documentation 18 videos · 37 moments · 99.0 minutes ## Humanizing Your Documentation - **Shifting focus to use case-driven documentation formatting** (01:49, 1min) — Focusing on user goals rather than just describing interface elements improves the utility of reference documentation. - **Documenting unexpected software errors and providing troubleshooting steps** (18:15, 1min) — Structuring error documentation to explain the cause and next actions reassures users when functionality fails. - **Adopting honest, helpful, and human technical documentation standards** (26:04, 1min) — Emphasizing accuracy alongside empathetic approachability builds a sustainable relationship with the developers using your product. - **Designing documentation simultaneously with feature implementation phases** (05:45, 1min) — Starting documentation at the use case phase rather than after feature completion streamlines the writing process. - **Introduction to humanizing your technical documentation** (00:05, 1min) — Applying empathy and a user-focused narrative to external-facing documentation improves the learning experience for end users. [Learn more](https://www.wearedevelopers.com/videos/476-humanizing-your-documentation) ## "I will remember that" and other lies - Why documentation matters and it makes your apps better - **Establishing ongoing documentation habits during software development** (24:32, 0min) — Logging architectural decisions concurrently alongside development workflows captures crucial context before it is irrevocably forgotten. - **Defining types of product documentation for software projects** (03:40, 2min) — Product documentation encompasses essential requirements, design records, API references, and test strategies rather than just basic project readmes. - **Driving business objectives through comprehensive technical documentation** (12:57, 6min) — Centralizing project information mitigates development risks, accelerates developer onboarding, and prevents teams from repeating historical mistakes. [Learn more](https://www.wearedevelopers.com/videos/925-i-will-remember-that-and-other-lies-why-documentation-matters-and-it-makes-your-apps-better) ## Technical Documentation - How Can I Write Them Better and Why Should I Care? - **Identifying common types of technical documentation** (02:50, 1min) — How system design briefs, project readme files, and onboarding outlines share essential team knowledge. - **Establishing centralized documentation and storage standards** (16:23, 0min) — How adopting a single knowledge base minimizes context switching and helps teams locate resources quickly. - **Adapting technical documentation for diverse audiences** (12:31, 3min) — Identifying what concepts must be covered for internal operating systems versus external API consumers. - **Enforcing documentation requirements in operational workflows** (25:23, 2min) — Equipping engineering managers to require updated documentation as an undeniable part of the definition of done. - **Career and team benefits of writing documentation** (05:39, 6min) — How documenting internal processes reduces daily interruptions while increasing team velocity and individual visibility. [Learn more](https://www.wearedevelopers.com/videos/681-technical-documentation-how-can-i-write-them-better-and-why-should-i-care) ## Documentation as a Tool: Introducing Documentation Driven Development - **Introducing documentation driven development as a tool** (00:01, 3min) — Treating documentation as a map before coding ensures clear directions and reduces development errors. - **Boosting team productivity with comprehensive engineering documentation** (19:55, 2min) — Establishing strong documentation habits reduces technical debt and accelerates both code understanding and overall innovation. - **Enhancing asynchronous collaboration with written documents** (03:27, 5min) — Moving technical discussions from chat applications to structured documents prevents information loss across time zones. [Learn more](https://www.wearedevelopers.com/videos/927-documentation-as-a-tool-introducing-documentation-driven-development) ## Stack Overflow: Community and AI - **Unifying internal documentation with enhanced enterprise search functionality** (22:52, 2min) — Enhanced enterprise search unifies disparate company document repositories to generate robust, cited technical answers for collaborative teams. [Learn more](https://www.wearedevelopers.com/videos/600-stack-overflow-community-and-ai) ## A Brief History of Data Storage - **The importance of documenting data encodings** (25:42, 1min) — Persisting data effectively demands strict comprehensive documentation of formats so future developers properly decode the preserved information. [Learn more](https://www.wearedevelopers.com/videos/974-a-brief-history-of-data-storage) ## Continuous Documentation for Your Code - **Using understanding-oriented documentation to explain integrations and software architecture** (08:08, 0min) — Highlighting architectural motivations and integrations helps broaden the technical understanding of how separate components interact together. - **Generating information-oriented reference documentation directly from source code** (08:59, 3min) — Using tools alongside code annotations automatically produces technical specifications that dynamically update with releases. - **Using goal-oriented documentation to create practical how-to guides** (05:47, 1min) — Writing step-by-step directions helps unblock developers when trying to fulfill specific tasks like installation operations. - **Discovering the long-term value of continuous software code documentation** (00:03, 3min) — How early experiences writing unstructured code demonstrate the need for evaluating completeness before passing it entirely to the future. - **Recognizing the four distinct frameworks of software engineering documentation** (03:48, 1min) — An analogy of a lost piece of code introduces distinct categories needed to properly inform other engineering teams. [Learn more](https://www.wearedevelopers.com/videos/798-continuous-documentation-for-your-code) ## Delay the AI Overlords: How OAuth and OpenFGA Can Keep Your AI Agents from Going Rogue - **Implementing OpenFGA document retrieval for AI agents** (11:26, 3min) — How an FGA retriever filters vector database results so language models only process authorized documents. [Learn more](https://www.wearedevelopers.com/videos/1637-delay-the-ai-overlords-how-oauth-and-openfga-can-keep-your-ai-agents-from-going-rogue) ## Architecture Communication Canvas - **Common pitfalls in standard architecture documentation** (00:26, 2min) — Traditional architecture documentation suffers from being entirely missing, overwhelmingly long, or incomprehensibly detailed. [Learn more](https://www.wearedevelopers.com/videos/674-architecture-communication-canvas) ## Making Documentation AI-Ready: Preparing Your Docs for the LLM Era - **Evaluating your documentation against AI-ready guidelines and checklists** (21:52, 2min) — Assessing scattered content segments against structured readiness checklists protects underlying document clarity across entirely unpredictable ret... - **Transitioning documentation from human readers to AI agents** (00:19, 4min) — The evolution of technical documentation now requires optimizing content for extraction by large language models. - **Structuring documentation chunks using the context sandwich technique** (07:04, 2min) — Structuring paragraphs with immediate answers, orienting categories, and situational nuance helps AI synthesize operating directives correctly. - **Preventing shadow documentation and managing API knowledge governance** (20:09, 1min) — Unsynchronized AI-generated summaries circulating inside company networks produce disjointed information boundaries that heavily compound factual h... [Learn more](https://www.wearedevelopers.com/videos/100199-making-documentation-ai-ready-preparing-your-docs-for-the-llm-era) ## Resistant to hype: How to avoid being deceived by technological trends? - **Documenting architectural choices with a dedicated decision log** (17:10, 2min) — Tracking requirements and evaluated alternatives in a central repository maintains the historical context behind major structural choices. [Learn more](https://www.wearedevelopers.com/videos/1136-resistant-to-hype-how-to-avoid-being-deceived-by-technological-trends) ## Let your iOS app read texts - **Reviewing Xcode implementations and Vision framework documentation reference resources** (27:25, 2min) — Exploring Swift file components and navigating the Apple developer ecosystem libraries to discover and extend algorithmic features. [Learn more](https://www.wearedevelopers.com/videos/167-let-your-ios-app-read-texts) ## Make Your Data FABulous - **Document text search algorithms and BM25 relevance scoring** (17:20, 3min) — Search algorithms mathematically evaluate document relevance using term frequency, inverse document frequency, and analyzed field lengths. [Learn more](https://www.wearedevelopers.com/videos/430-make-your-data-fabulous) ## You don't need to write the code. You need to become a verification architect and prove it's correct - **Capturing standards with decision records and markdown files** (16:41, 3min) — Documenting specialized team patterns and architectural decisions in simple text files ensures agents follow strict domain best practices. [Learn more](https://www.wearedevelopers.com/videos/100023-you-don-t-need-to-write-the-code-you-need-to-become-a-verification-architect-and-prove-it-s-correct) ## Leveraging Storybook for Component Driven Development outside of your classic Component Library. - **Building and documenting UI components in isolation** (11:04, 5min) — Writing standardized story formats automatically yields interactive documentation and reusable code snippets. [Learn more](https://www.wearedevelopers.com/videos/975-leveraging-storybook-for-component-driven-development-outside-of-your-classic-component-library) ## Automated Code Quality Checks with Custom SonarQube Rules - **Documenting and sharing standard software coding guidelines centrally** (11:20, 5min) — Relying strictly on basic static analysis is insufficient without aligned developer habits and detailed organizational documentation. [Learn more](https://www.wearedevelopers.com/videos/428-automated-code-quality-checks-with-custom-sonarqube-rules) ## Preventing Accessibility Issues Instead Of Fixing Them - **Documenting custom widget interactions for engineering handoff** (33:06, 2min) — Explicitly noting aria patterns and control flows avoids misinterpretations between interface designers and frontend product developers. [Learn more](https://www.wearedevelopers.com/videos/804-preventing-accessibility-issues-instead-of-fixing-them) ## Open sourcing a library: how hard can that be? - **Documenting technical code and structural architectural decisions** (10:58, 2min) — Creating actionable sample projects and recording design decisions to streamline open-source collaboration. [Learn more](https://www.wearedevelopers.com/videos/1058-open-sourcing-a-library-how-hard-can-that-be)