technical-writer

Automate developer documentation and runbooks with template-driven, Diátaxis-aligned structure.

181|30|Updated Nov 16, 2025
One-click install
npx skills add https://github.com/erichowens/some_claude_skills --skill technical-writer-erichowens
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/erichowens/some_claude_skills/tree/main/.claude/skills/technical-writer
Command: npx skills add https://github.com/erichowens/some_claude_skills --skill technical-writer-erichowens

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill helps automate the creation, structuring, and validation of developer docs, API references, and runbooks, reducing manual drafting time and ensuring consistency across docs.

Core Features & Use Cases

  • Template-driven documentation: Use provided templates for README, ADRs, API references, and runbooks to accelerate authoring.
  • Diátaxis-aligned guidance: Apply the Diátaxis framework to categorize tutorials, how-tos, explanations, and references.
  • Quality anti-patterns: Implement structured anti-patterns to improve clarity and maintainability.
  • Use Case: Generate a complete API reference from a minimal spec file using the included templates.

Quick Start

Activate the Technical Writer to generate an API reference for a new endpoint from your OpenAPI spec. For example, run: "Create an API reference for /users using the API Reference Template and ensure proper authentication and error sections."

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I structure developer documentation using the Diátaxis framework?

Diátaxis organizes documentation into four categories: tutorials (learning-oriented), how-to guides (task-oriented), explanations (understanding-oriented), and references (information-oriented). This Skill applies Diátaxis alignment to automatically categorize and structure your API docs, README files, ADRs, and runbooks, ensuring consistency and clarity across all documentation types.

Can I automate API reference generation from an OpenAPI spec?

Yes. This Skill uses template-driven automation to generate complete API references from minimal spec files. Provide your OpenAPI specification and select the API Reference Template to produce properly structured documentation with authentication, error handling, and endpoint sections automatically filled in.

What templates does this Skill provide for documentation?

The Skill includes templates for README files, Architecture Decision Records (ADRs), API references, and runbooks. Each template follows Diátaxis principles and incorporates anti-pattern guidance to reduce manual drafting time while maintaining consistency, versioning support, and cross-link validation across your documentation.

How do anti-patterns improve documentation quality?

Anti-patterns are structured guides that highlight common documentation mistakes and their fixes. This Skill embeds anti-pattern coverage into templates and quality checks to help you identify unclear phrasing, missing sections, and maintainability issues before publishing, resulting in clearer, more usable developer docs.

Does this Skill validate cross-links and consistency across docs?

Yes. The Skill includes tooling integration for quality checks that perform cross-link validation and consistency verification across your documentation suite. This catches broken references and ensures terminology and structure remain aligned across README, API docs, runbooks, and knowledge-base articles.

What output formats and versioning does the documentation support?

The Skill supports markdown and template-driven output formats for tutorials, how-to guides, explanations, and references. It includes versioning capabilities to manage multiple documentation versions and ensures proper linking and organization as your APIs and architecture evolve.