Does this skill support specific documentation frameworks?

Yes, it is designed to work with popular static site generators and documentation tools like Docusaurus, MkDocs, VitePress, and Astro.

How does it ensure documentation quality?

The skill uses a rigorous quality checklist and the Diátaxis framework to ensure content is structured correctly, links are valid, and examples are tested.

Can it help with internal system documentation?

Absolutely. It includes specialized templates and patterns for internal runbooks, system architecture documentation, and operational procedures.

What is the Diátaxis framework used by this skill?

Diátaxis is a systematic approach to technical documentation that categorizes content into four types based on user needs: tutorials, how-to guides, explanations, and references.

Does it handle marketing copy or blog posts?

No, this skill is specialized for technical developer documentation. For marketing or editorial content, you should use copywriting or content-specific skills.

Technical Writer

Name: Technical Writer
Author: erichowens

byerichowens

•

학습 및 문서화

Drafts, maintains, and audits high-quality developer documentation including API references, READMEs, and system runbooks.

소개

The Technical Writer skill transforms complex technical information into accessible, well-structured documentation using the Diátaxis framework. It helps developers maintain consistent standards for READMEs, Architecture Decision Records (ADRs), and API guides while avoiding common pitfalls like 'expert blindness' or outdated examples. Whether you need to generate a new tutorial from scratch or audit existing docs for broken links and clarity, this skill ensures your project's knowledge base remains accurate, user-friendly, and professionally formatted.

주요 기능

Validates technical accuracy by ensuring code examples are tested, runnable, and contextually relevant.
Integrates with popular documentation tools including Docusaurus, MkDocs, VitePress, and Swagger.
6 GitHub stars
Implements the Diátaxis framework to balance tutorials, how-to guides, explanations, and references.
Automates the creation of standardized READMEs, ADRs, and API documentation using built-in templates.
Audits documentation for anti-patterns such as missing prerequisites, broken links, and expert blindness.

사용 사례

Drafting Architecture Decision Records (ADRs) to document and track key system design choices.
Improving project onboarding by creating step-by-step tutorials and troubleshooting guides for new developers.
Generating comprehensive API references and REST documentation from source code or specifications.

소개

주요 기능

Validates technical accuracy by ensuring code examples are tested, runnable, and contextually relevant.
Integrates with popular documentation tools including Docusaurus, MkDocs, VitePress, and Swagger.
6 GitHub stars
Implements the Diátaxis framework to balance tutorials, how-to guides, explanations, and references.
Automates the creation of standardized READMEs, ADRs, and API documentation using built-in templates.
Audits documentation for anti-patterns such as missing prerequisites, broken links, and expert blindness.

사용 사례

Drafting Architecture Decision Records (ADRs) to document and track key system design choices.
Improving project onboarding by creating step-by-step tutorials and troubleshooting guides for new developers.
Generating comprehensive API references and REST documentation from source code or specifications.