Documentation
37 moments from 18 videos · 1:38:57 total
These curated talk segments help engineers and technical writers establish documentation processes that actually resolve developer friction.
Shifting focus to use case-driven documentation formatting
Focusing on user goals rather than just describing interface elements improves the utility of reference documentation.
Documenting unexpected software errors and providing troubleshooting steps
Structuring error documentation to explain the cause and next actions reassures users when functionality fails.
Adopting honest, helpful, and human technical documentation standards
Emphasizing accuracy alongside empathetic approachability builds a sustainable relationship with the developers using your product.
Designing documentation simultaneously with feature implementation phases
Starting documentation at the use case phase rather than after feature completion streamlines the writing process.
Introduction to humanizing your technical documentation
Applying empathy and a user-focused narrative to external-facing documentation improves the learning experience for end users.
Establishing ongoing documentation habits during software development
Logging architectural decisions concurrently alongside development workflows captures crucial context before it is irrevocably forgotten.
Defining types of product documentation for software projects
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
Centralizing project information mitigates development risks, accelerates developer onboarding, and prevents teams from repeating historical mistakes.
Identifying common types of technical documentation
How system design briefs, project readme files, and onboarding outlines share essential team knowledge.
Establishing centralized documentation and storage standards
How adopting a single knowledge base minimizes context switching and helps teams locate resources quickly.
Adapting technical documentation for diverse audiences
Identifying what concepts must be covered for internal operating systems versus external API consumers.
Enforcing documentation requirements in operational workflows
Equipping engineering managers to require updated documentation as an undeniable part of the definition of done.
Career and team benefits of writing documentation
How documenting internal processes reduces daily interruptions while increasing team velocity and individual visibility.
Introducing documentation driven development as a tool
Treating documentation as a map before coding ensures clear directions and reduces development errors.
Boosting team productivity with comprehensive engineering documentation
Establishing strong documentation habits reduces technical debt and accelerates both code understanding and overall innovation.
Enhancing asynchronous collaboration with written documents
Moving technical discussions from chat applications to structured documents prevents information loss across time zones.
Unifying internal documentation with enhanced enterprise search functionality
Enhanced enterprise search unifies disparate company document repositories to generate robust, cited technical answers for collaborative teams.
The importance of documenting data encodings
Persisting data effectively demands strict comprehensive documentation of formats so future developers properly decode the preserved information.
Using understanding-oriented documentation to explain integrations and software architecture
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
Using tools alongside code annotations automatically produces technical specifications that dynamically update with releases.
Using goal-oriented documentation to create practical how-to guides
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
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
An analogy of a lost piece of code introduces distinct categories needed to properly inform other engineering teams.
Implementing OpenFGA document retrieval for AI agents
How an FGA retriever filters vector database results so language models only process authorized documents.
Common pitfalls in standard architecture documentation
Traditional architecture documentation suffers from being entirely missing, overwhelmingly long, or incomprehensibly detailed.
Evaluating your documentation against AI-ready guidelines and checklists
Assessing scattered content segments against structured readiness checklists protects underlying document clarity across entirely unpredictable retrieval pathways.
Transitioning documentation from human readers to AI agents
The evolution of technical documentation now requires optimizing content for extraction by large language models.
Structuring documentation chunks using the context sandwich technique
Structuring paragraphs with immediate answers, orienting categories, and situational nuance helps AI synthesize operating directives correctly.
Preventing shadow documentation and managing API knowledge governance
Unsynchronized AI-generated summaries circulating inside company networks produce disjointed information boundaries that heavily compound factual hallucinations.
Documenting architectural choices with a dedicated decision log
Tracking requirements and evaluated alternatives in a central repository maintains the historical context behind major structural choices.
Reviewing Xcode implementations and Vision framework documentation reference resources
Exploring Swift file components and navigating the Apple developer ecosystem libraries to discover and extend algorithmic features.
Document text search algorithms and BM25 relevance scoring
Search algorithms mathematically evaluate document relevance using term frequency, inverse document frequency, and analyzed field lengths.
Capturing standards with decision records and markdown files
Documenting specialized team patterns and architectural decisions in simple text files ensures agents follow strict domain best practices.
Building and documenting UI components in isolation
Writing standardized story formats automatically yields interactive documentation and reusable code snippets.
Documenting and sharing standard software coding guidelines centrally
Relying strictly on basic static analysis is insufficient without aligned developer habits and detailed organizational documentation.
Documenting custom widget interactions for engineering handoff
Explicitly noting aria patterns and control flows avoids misinterpretations between interface designers and frontend product developers.
Documenting technical code and structural architectural decisions
Creating actionable sample projects and recording design decisions to streamline open-source collaboration.
Your mix. Instantly.
More mixes
AI & Machine Learning
AI coding agents
AI & Machine Learning
MCP (Model Context Protocol)
AI & Machine Learning
RAG
Languages & Frameworks
TypeScript
Languages & Frameworks
React
Languages & Frameworks
Java
Cloud, Platform & Data
Platform engineering
Cloud, Platform & Data
Observability
Cloud, Platform & Data
Infrastructure as code
Architecture, Quality & Security
System architecture
Architecture, Quality & Security
Code review
Architecture, Quality & Security
Software supply chain security
Leadership, Career & Community
Engineering strategy
Leadership, Career & Community
Developer experience
Leadership, Career & Community