documentation-writing

Technical README generation creates comprehensive project overviews following best practices, ensuring complex systems are easily understood by the target audience through clear structure and actionable content.

The Diátaxis framework organizes technical documentation into four distinct types: tutorials, how-to guides, explanations, and references. This Skill adheres to the framework to structure content by purpose and audience for effective knowledge transfer.

Creating an Architecture Decision Record (ADR) involves documenting design choices and their context. This Skill helps write structured ADRs to capture architectural decisions clearly for future reference and team alignment.

Developing an operational runbook is best handled by generating actionable guides for system management and troubleshooting. This Skill creates clear operational documentation to support teams during incident response and routine maintenance.

Yes, audience-aware documentation is the core focus. It structures content by purpose and audience using the Diátaxis framework, ensuring effective knowledge transfer across different reader profiles from learners to practitioners.

You need structured technical documentation when maintaining complex systems that require clear, audience-aware explanations. Ad-hoc notes fail to scale, whereas a structured approach using READMEs, ADRs, and runbooks ensures sustainable knowledge transfer.