write-docs

Generate structured, audience-calibrated documentation from a codebase.

14|Updated Apr 1, 2026
One-click install
npx skills add https://github.com/hungv47/meta-skills --skill write-docs-hungv47
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-docs
Source: https://github.com/hungv47/meta-skills/tree/main/forsvn-dev/skills/product/write-docs
Command: npx skills add https://github.com/hungv47/meta-skills --skill write-docs-hungv47

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically generate structured, audience-calibrated documentation from a codebase, including READMEs, API references, setup guides, runbooks, architecture docs, and release notes.

Core Features & Use Cases

  • Reads artifact frontmatter and routing templates to produce canonical docs across default surfaces (README, User Guide, API Reference, Config Guide, Tutorial) and Route D/E ship-log and audit flows.
  • Orchestrates a multi-agent pipeline (scanner, concept extractor, audience profiler, writer, staleness checker, critic) to ensure accuracy, consistency, and freshness.
  • Maintains traceability from code to docs via the artifact frontmatter and manifest-sync integration, enabling safe per-doc-type lifecycles.

Quick Start

Point this skill at a codebase to generate structured, audience-calibrated documentation.

Frequently Asked Questions about write-docs

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

FAQPage Schema
How do I automatically generate README and API reference docs from a codebase?

To generate README and API reference docs from a codebase, use an automated documentation skill that scans source files and orchestrates a multi-agent pipeline to produce structured, audience-calibrated markdown outputs.

What is the best way to keep architecture docs and runbooks aligned with code changes?

Keeping architecture docs and runbooks aligned with code changes requires a staleness checker that validates artifact frontmatter against a manifest, ensuring documentation freshness and traceability throughout the lifecycle.

How do I create audience-calibrated setup guides and tutorials for different user roles?

Creating audience-calibrated setup guides and tutorials involves applying an audience profiler within a documentation pipeline, adjusting the generated content depth and tone to match specific reader requirements.

Can I generate ship-log and audit documentation automatically for release notes?

Yes, you can generate ship-log and audit documentation for release notes automatically by utilizing routing templates that direct codebase changes into structured CHANGELOG entries and audit flows.

Does automated documentation generation work without external dependencies?

Automated documentation generation can work without external dependencies, operating as a standalone skill that reads artifact frontmatter and routing templates to validate outputs against the manifest frontmatter contract.

What are the limitations of using automated writer-agents for technical documentation?

Limitations of using automated writer-agents for technical documentation include potential staleness if manifest-sync integration is skipped, requiring a critic agent to validate accuracy and consistency before final markdown output.