doc-writer

Generate grounded technical Markdown documentation from session context, code, and source files.

Updated Apr 2, 2026
One-click install
npx skills add https://github.com/nico0695/ai-tools --skill doc-writer-nico0695
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-writer
Source: https://github.com/nico0695/ai-tools/tree/main/skills/generic-skills/doc-writer
Command: npx skills add https://github.com/nico0695/ai-tools --skill doc-writer-nico0695

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve? Technical documentation often reads well but is quietly wrong, filled in from what usually goes in a section rather than from what the sources actually say. This Skill turns available context — a session, a diff, a spec, or files you point at — into a Markdown document where every claim is traced to a source, gaps are stated openly, and conflicts are documented instead of silently resolved. ## Core Features & Use Cases - Evidence-based writing pipeline: harvests sources into a context map, classifies every fact by evidence level (confirmed, inferred, unknown, conflicting) and relevance, then validates the draft against the sources rather than against itself. - Nine discovered document templates: architecture, technical overview, feature, API reference, ADR, runbook, investigation, project report, and generic — selected by matching your goal and audience, with new templates picked up automatically from the assets folder. - Interactive and auto modes: interactive mode gates on plan approval for documents others will read; auto mode self-reviews and writes straight through for fast captures of work you just did. - Use case: after finishing a feature or debugging session, ask it to document what was built — it produces a grounded feature doc or investigation report with diagrams and tables only where they carry real relationships. ## Quick Start Ask the assistant to document the feature you just implemented as a Markdown file using the available session context and changed files.

Frequently Asked Questions about doc-writer

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

FAQPage Schema
How do I generate technical documentation from a coding session?▼

Ask for the document explicitly, for example "document this" or "write an ADR for this decision". The skill harvests the session, diffs, and named files into a context map, classifies facts by evidence, picks a matching template, and writes a grounded Markdown document.

What document types can this skill write?▼

It ships nine templates: architecture, technical overview, feature, API reference, ADR, runbook, investigation, project report, and a generic fallback. It recommends a type by matching your goal and audience against each template's use_when metadata, and you can override the choice.

What is the difference between interactive and auto mode?▼

Both modes run the same analysis. Interactive mode stops for plan approval before writing and asks about genuine scope ambiguity, suiting documents others will read. Auto mode self-reviews the plan and writes straight through, suiting fast captures of work you just did.

How does it prevent hallucinated content in documentation?▼

Every fact is classified as confirmed, inferred, unknown, or conflicting, and the final validation pass re-reads the sources rather than the draft. Unsupported claims are fixed, qualified, or deleted, and diagrams may never include components or relationships no source establishes.

Can I add custom documentation templates?▼

Yes. Copy the closest existing template, edit it, and drop it into the assets/templates folder with a YAML metadata block defining id, use_when, and required sections. Templates are discovered at runtime, so no changes to the skill itself are needed.

When should I not use this documentation skill?▼

Do not use it to review existing docs against current code for drift, to draw standalone diagrams, or to maintain documents over time. It only writes new documentation from available sources; drift detection belongs to a separate reviewer skill.