← ClaudeAtlas

documentationlisted

Documentation standards and code-to-docs sync conventions for Forge projects — JSDoc/TSDoc annotations, README/CHANGELOG structure, auto-generated API reference, doc-tree layout, and staleness detection. Use when writing or reviewing docs, adding JSDoc to exported functions, structuring a docs/ tree, deciding what to document vs auto-generate, or running the Forge docs commands (/forge:docs-status, /forge:docs-audit, /forge:docs-update).
nxtg-ai/forge-plugin · ★ 5 · AI & Automation · score 73
Install: claude install-skill nxtg-ai/forge-plugin
# Documentation Management **Purpose**: Keep documentation synchronized with code **Primary Agent**: `release-sentinel` (opus) — docs↔code sync, staleness, changelog generation **Supporting Agent**: `docs` (sonnet) — writes JSDoc/README/API/architecture docs **Contributors**: all agents (each documents its own output) --- ## The Documentation Promise > "Every feature is documented. Every change is tracked. > No user is left wondering how something works." The doc tree below is the **recommended layout for a consuming project** — it is aspirational, not the structure of this plugin repo itself. Adopt the parts that fit; do not scaffold empty directories to match it. --- ## Documentation Hierarchy ```` docs/ ├── README.md # Entry point, always current ├── CHANGELOG.md # Auto-generated from commits ├── CONTRIBUTING.md # How to contribute ├── ├── getting-started/ # Onboarding │ ├── installation.md │ ├── quick-start.md │ └── first-project.md │ ├── guides/ # How-to guides │ ├── authentication.md │ ├── deployment.md │ └── troubleshooting.md │ ├── api/ # API reference (auto-generated) │ ├── overview.md │ ├── users.md │ ├── projects.md │ └── webhooks.md │ ├── components/ # Component docs (auto-generated) │ ├── button.md │ ├── input.md │ └── card.md │ ├── cli/ # CLI reference (auto-generated) │ └── commands.md │ ├── architecture/