do-document

Generates API references, user guides, architecture indexes, and cited research reports from codebases.

Updated Jul 9, 2026
One-click install
npx skills add https://github.com/khoavu882/do-flow --skill do-document-khoavu882
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: do-document
Source: https://github.com/khoavu882/do-flow/tree/main/core/shared/skills/do-document
Command: npx skills add https://github.com/khoavu882/do-flow --skill do-document-khoavu882

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Writing and maintaining technical documentation is time-consuming, and research reports often contain unverified claims or fabricated citations. This Skill automates the generation of grounded documentation and enforces evidence tracking so every factual claim traces back to a real source. ## Core Features & Use Cases - Five Documentation Modes: Generate API references, task-oriented user guides, implementation flow summaries, whole-project architecture indexes, and deep web research reports via the --type flag. - Evidence Ledger Integration: Batches extracted facts and inferred claims into a structured evidence record, refusing unverifiable confidence scores so documentation never asserts something nobody checked. - Cited Research Reports: Performs multi-hop web research with full resolvable URLs for every citation, clearly separating extracted facts from the author's own synthesis. - Use Case: After shipping a feature, run /do-document my-feature --type impl to produce an implementation-flow summary covering key decisions, deviations from the plan, changed surfaces, and test verification. ## Quick Start Ask the AI to document the authentication module as an API reference by invoking /do-document with the target path and --type api.

Frequently Asked Questions about do-document

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

FAQPage Schema
How do I generate API documentation from source code?▼

Run /do-document with the target module and --type api. The skill extracts real exported names, signatures, and docstrings directly from source files and formats them using the API reference template with request, response, and usage example sections.

How to write a research report with verified citations?▼

Use /do-document with --type research and your query. The skill decomposes the question, runs multi-hop retrieval, and produces a report where every cited source carries a full resolvable URL, with extracted facts explicitly separated from the author's inferences.

What documentation types does do-document support?▼

It supports five types: api for endpoint and interface references, guide for task-oriented user documentation, impl for feature implementation flow summaries, index for whole-project architecture overviews, and research for cited web research reports.

Can do-document modify my code while documenting it?▼

No. The skill's stated boundaries forbid modifying business logic code. It only reads source files to extract interfaces and generates markdown documentation, implementation summaries, architecture indexes, or research reports.

Why does the evidence batch get rejected when recording documentation facts?▼

The runtime refuses any evidence item containing score, confidence, relevance, or similarity fields and rejects the whole batch. Record each fact as extracted with a locator, or as inferred with content, using the schema in the EVIDENCE_LEDGER reference.