docs

Generates API reference, developer guides, and user help documentation from codebase and PRD.

4|Updated Mar 14, 2026
One-click install
npx skills add https://github.com/VoxTechnologies/transmute-framework --skill docs-voxtechnologies
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/VoxTechnologies/transmute-framework/tree/main/skills/docs
Command: npx skills add https://github.com/VoxTechnologies/transmute-framework --skill docs-voxtechnologies

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Writing comprehensive product documentation manually is slow and error-prone, and docs written from memory often contain hallucinated API signatures or stale information. This Skill coordinates a multi-agent documentation workflow that derives help docs, API references, and developer onboarding guides directly from the actual codebase, PRD, and BRD. ## Core Features & Use Cases - Multi-Agent Documentation Generation: Spawns three specialized teammates (help-docs-writer, api-docs-writer, developer-guide-writer) to produce user help docs, backend API references, and developer onboarding guides in parallel. - Source-Verified API Docs: Enforces 100% source verification so every documented function signature, argument type, return value, and error code is read from actual source files rather than assumed. - Pipeline Gate Integration: Runs as Stage 6D of the Transmute Plan Casting pipeline, checking prerequisite audit reports (implementation completeness, refactoring, resilience) and emitting a PASS/CONDITIONAL PASS/FAIL gate decision. - Use Case: After your product's features are implemented and audited, ask the agent to generate documentation and receive a complete docs/ tree with getting-started guides, per-feature help pages, per-domain API references, a developer setup guide, and a changelog organized by feature priority. ## Quick Start Ask the agent to generate documentation for the codebase, and it will verify prerequisites, spawn documentation teammates, and produce the full docs/ directory with an audit report.

Frequently Asked Questions about docs

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

FAQPage Schema
How do I generate API documentation from my codebase automatically?

This Skill spawns an api-docs-writer agent that reads every backend function source file and documents signatures, argument types, return values, auth requirements, and error codes. It produces per-domain markdown files under docs/api/ with TypeScript usage examples.

How to write a developer onboarding guide for a new project?

The developer-guide-writer teammate generates architecture overview, local setup steps, conventions, testing, and deployment guides under docs/developer/. It cross-references .env.local.example to document all required environment variables and verifies code examples against actual source files.

Does this documentation skill work with frameworks other than Convex and Next.js?

Yes, the Skill adapts to any stack defined in plancasting/tech-stack.md. References to Convex directories, schema files, and commands are mapped to your actual backend directory, migration files, and package manager.

What happens if documentation is generated before all features are complete?

The Skill checks the Stage 5B implementation completeness report and blocks execution if more than 25% of features or any P0 feature is incomplete. Incomplete features are documented as Planned with a callout rather than as available functionality.

Why do generated API docs sometimes contain wrong function signatures?

Hallucinated signatures occur when documentation is written from memory instead of source code. This Skill prevents that by requiring 100% source verification, where every documented function is read from its actual file and the lead spot-checks at least 10 functions as a failsafe.