Topic mix

Documentation

41 moments from 25 videos · 1:39:44 total

These curated talk segments help engineers and technical writers establish documentation processes that actually resolve developer friction.

Humanizing Your Documentation
Play section Shifting focus to use case-driven documentation formatting Shifting focus to use case-driven documentation formatting thumbnail Shifting focus to use case-driven documentation formatting Focusing on user goals rather than just describing interface elements improves the utility of reference documentation.
Play section Documenting unexpected software errors and providing troubleshooting steps Documenting unexpected software errors and providing troubleshooting steps thumbnail Documenting unexpected software errors and providing troubleshooting steps Structuring error documentation to explain the cause and next actions reassures users when functionality fails.
Play section Adopting honest, helpful, and human technical documentation standards Adopting honest, helpful, and human technical documentation standards thumbnail Adopting honest, helpful, and human technical documentation standards Emphasizing accuracy alongside empathetic approachability builds a sustainable relationship with the developers using your product.
Play section Introduction to humanizing your technical documentation Introduction to humanizing your technical documentation thumbnail Introduction to humanizing your technical documentation Applying empathy and a user-focused narrative to external-facing documentation improves the learning experience for end users.
Play section Designing documentation simultaneously with feature implementation phases Designing documentation simultaneously with feature implementation phases thumbnail Designing documentation simultaneously with feature implementation phases Starting documentation at the use case phase rather than after feature completion streamlines the writing process.
A Developer's Framework for Any Tool Migration
Play section Creating living internal documentation with traceability and version control Creating living internal documentation with traceability and version control thumbnail Creating living internal documentation with traceability and version control Establishing context-specific usage guidelines prevents the duplication of official vendor manuals and maintains process history.
"I will remember that" and other lies - Why documentation matters and it makes your apps better
Play section Establishing ongoing documentation habits during software development Establishing ongoing documentation habits during software development thumbnail Establishing ongoing documentation habits during software development Logging architectural decisions concurrently alongside development workflows captures crucial context before it is irrevocably forgotten.
Play section Defining types of product documentation for software projects Defining types of product documentation for software projects thumbnail 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.
Play section Driving business objectives through comprehensive technical documentation Driving business objectives through comprehensive technical documentation thumbnail Driving business objectives through comprehensive technical documentation Centralizing project information mitigates development risks, accelerates developer onboarding, and prevents teams from repeating historical mistakes.

Loading the rest of your playlist…

Your mix. Instantly.

More mixes