documentation-builder

Generate verified project guides, READMEs, and runbooks from repository evidence.

Updated Aug 1, 2026
One-click install
npx skills add https://github.com/QuyDu/Skills-Orchestrator --skill documentation-builder-quydu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-builder
Source: https://github.com/QuyDu/Skills-Orchestrator/tree/main/.github/skills/documentation-builder
Command: npx skills add https://github.com/QuyDu/Skills-Orchestrator --skill documentation-builder-quydu

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve? Project documentation drifts out of sync with the code it describes, and manually verifying every command, path, and configuration key is slow and error-prone. This Skill generates and refreshes documentation that is provably consistent with the repository, so readers never encounter stale setup steps or invented behavior. ## Core Features & Use Cases - Verified Project Guide Generation: Builds docs/PROJECT-GUIDE.md plus a machine-readable reports/project-guide.json whose claims are bound to Project Understanding digests via SHA-256 hashes. - Staleness Validation: The validate command rejects guides whose underlying Project Understanding artifacts or evidence files have changed, failing closed instead of publishing unverified claims. - Audience-Scoped Documents: Produces READMEs, decision records, deployment guides, and operations runbooks with exactly one audience per document, explicitly marking planned or unimplemented behavior. - Use Case: After a major refactor, run the build command to regenerate the project guide from the current repository scan, then validate it before publishing so every command and path matches the actual code. ## Quick Start Ask the agent to rebuild the project guide and README from verified repository evidence, then validate the output before publishing.

Frequently Asked Questions about documentation-builder

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

FAQPage Schema
How do I generate a project guide from my repository?

Run the documentation-builder script with the build command after completing a project-understanding scan. It reads reports/project-understanding.json and writes docs/PROJECT-GUIDE.md plus reports/project-guide.json with evidence-backed claims.

How do I check if my project documentation is stale?

Run the script's validate command, which compares SHA-256 digests of the Project Understanding JSON and Markdown against the recorded values. Any drift in the underlying evidence or guide content causes validation to fail with specific errors.

Does the documentation builder require other skills to run first?

Yes, the build command fails if Project Understanding outputs are missing or incomplete, so project-understanding scan must run first. It also composes with clarify-the-ask when audience, scope, or product intent is ambiguous.

What happens when the repository lacks evidence for a document?

The skill fails closed: it leaves the document unchanged, reports it as blocked, and never invents setup steps, commands, endpoints, or architecture to fill gaps. Claims without valid evidence files are filtered out during the build.

Can the generated documentation include secrets or internal identifiers?

No, the skill explicitly prohibits secrets, tokens, tenant or subscription identifiers, customer names, and personal data in any output. It also refuses to contradict machine-readable reports under reports/, citing them instead.