technical-documentation-writer

Writes, rewrites, and audits technical documentation using Diataxis routing and evidence-based templates.

Updated Aug 22, 2026
One-click install
npx skills add https://github.com/JustinChangTW/ai-skills-core --skill technical-documentation-writer-justinchangtw
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-documentation-writer
Source: https://github.com/JustinChangTW/ai-skills-core/tree/main/skills/06-writing-editing/technical-documentation-writer
Command: npx skills add https://github.com/JustinChangTW/ai-skills-core --skill technical-documentation-writer-justinchangtw

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve? Technical documentation often looks complete but fails in practice: missing prerequisites, no verification steps, mixed document types, and invented details. This Skill turns scattered repo knowledge, existing drafts, and product information into executable, maintainable documentation that readers can actually follow. ## Core Features & Use Cases - Document type routing: Classifies each document as tutorial, how-to, reference, or explanation using Diataxis before drafting, preventing mixed-purpose documents. - Evidence-driven drafting: Inventories repos, existing docs, CLI help, config files, and official sources before writing, and marks unverifiable claims as assumptions or open gaps. - Quality auditing: Ships a deterministic Python script (doc_quality_audit.py) plus checklists to verify structure, executability, and completeness for READMEs, runbooks, migration guides, and API docs. - Use Case: Ask it to build an onboarding README from a repo, rewrite a confusing API usage guide with version scope and error examples, or run a docs gap analysis that outputs a prioritized documentation map. ## Quick Start Ask the assistant to write a README and Quick Start for your repository, including prerequisites, setup steps, verification, and troubleshooting.

Frequently Asked Questions about technical-documentation-writer

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

FAQPage Schema
How do I write a README and Quick Start for my repository?▼

Provide the repo contents and target audience, and the Skill builds a doc brief first, then drafts a README with prerequisites, installation steps, a first success path, verification, and common failure troubleshooting. It grounds every step in evidence from the repo rather than guessing.

How to structure API documentation with examples?▼

API usage guides are treated as reference documents covering authentication, version scope, endpoints, request parameters, success and failure response examples, limits, and common errors. Uncertain fields are explicitly marked as to-be-confirmed instead of being fabricated.

What is the Diataxis framework for documentation?▼

Diataxis classifies documentation into four types: tutorials for learning, how-to guides for tasks, reference for lookup, and explanation for understanding. This Skill routes each document to one primary type before drafting so content structure matches reader intent.

Can this Skill audit existing documentation for gaps?▼

Yes, docs gap analysis produces a documentation map listing existing docs, missing docs, target audiences, priorities with rationale, and recommended templates. It also includes a Python script that scores Markdown drafts against required sections for each document type.

When should I not use a technical documentation writer?▼

It is out of scope for PRDs, product specs, acceptance criteria, marketing copy, and slide decks. Requests to define requirements for features that do not exist yet should go to a spec or requirements workflow instead.