documentation-writing

Generate READMEs, ADRs, and runbooks using the Diátaxis framework.

1|Updated Mar 5, 2026

Search Tags:#documentation #writing #technical writing #adr #readme #runbook

Ready to run

npx skills add https://github.com/baphled/dotopencode --skill documentation-writing-baphled

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-writing
Source: https://github.com/baphled/dotopencode/tree/main/skills/documentation-writing
Command: npx skills add https://github.com/baphled/dotopencode --skill documentation-writing-baphled

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the challenge of creating and maintaining clear, structured, and audience-aware technical documentation, ensuring that complex systems are easily understood.

Core Features & Use Cases

README Generation: Creates comprehensive project READMEs following best practices.
ADR Documentation: Helps in writing Architecture Decision Records to capture design choices.
Runbook Creation: Develops operational guides for system management and troubleshooting.
Diátaxis Framework Adherence: Organizes documentation into tutorials, how-to guides, explanations, and references.

Quick Start

Use the documentation-writing skill to create a README for a new Python project.

Frequently Asked Questions about documentation-writing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I write a technical README for a new project?▼

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.

What is the Diátaxis framework for organizing technical documentation?▼

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.

How do I create an Architecture Decision Record to capture design choices?▼

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.

What is the best way to develop an operational runbook for system troubleshooting?▼

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.

Does this documentation writing approach work for audience-aware knowledge transfer?▼

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.

When do I need structured technical documentation instead of ad-hoc notes?▼

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.