docs

Solid

Dispatch docs subagent to audit, generate, and validate documentation against the codebase.

AI & Automation 321 stars 53 forks Updated today MIT

Install

View on GitHub

Quality Score: 86/100

Stars 20%
84
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# /docs — Documentation Generation Audit existing documentation, identify gaps, generate what's missing, and validate every claim against actual code. Can be invoked standalone or as part of `/work`. ## When to Use - Codebase has undocumented modules, APIs, or workflows - Existing documentation is stale or references removed features - A wish deliverable includes documentation - After significant code changes that invalidate existing docs - After `/work` completes — suggest `/docs` to document what changed ## Documentation Surfaces Audit and maintain these doc types: | Type | Location | Purpose | |------|----------|---------| | **README** | `README.md`, `*/README.md` | Project/module overview, setup, usage | | **CLAUDE.md** | `CLAUDE.md`, `*/CLAUDE.md` | Project conventions, commands, gotchas for AI agents | | **API docs** | `docs/api/`, inline JSDoc/TSDoc | Endpoint contracts, request/response schemas | | **Architecture** | `docs/architecture.md`, `ARCHITECTURE.md` | System design, data flow, component relationships | | **Inline docs** | JSDoc, TSDoc, docstrings | Function/class/module-level documentation | **CLAUDE.md is a first-class documentation surface.** When the codebase changes significantly (new commands, changed conventions, removed features), flag CLAUDE.md for update. CLAUDE.md should always reflect the current state of the project. ## Flow 1. **Audit existing docs:** scan all documentation surfaces above — map what exists. 2. **Identify gaps:** compare do...

Details

Author
automagik-dev
Repository
automagik-dev/genie
Created
10 months ago
Last Updated
today
Language
TypeScript
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

doc-scanner

Scans for project documentation files (AGENTS.md, CLAUDE.md, GEMINI.md, COPILOT.md, CURSOR.md, WARP.md, and 15+ other formats) and synthesizes guidance. Auto-activates when user asks to review, understand, or explore a codebase, when starting work in a new project, when asking about conventions or agents, or when documentation context would help. Can consolidate multiple platform docs into unified AGENTS.md.

335 Updated today
aiskillstore
AI & Automation Listed

write-docs

Generate documentation from a codebase — READMEs, API references, setup guides, runbooks, architecture docs, ship logs, release notes (CHANGELOG + GitHub Release bodies). Not for specifying what to build (use discover), restructuring code (use clean-code), or task decomposition (use breakdown-tasks).

10 Updated today
hungv47
Data & Documents Listed

documentation

Authors, audits, and maintains project documentation across CLAUDE.md / .claude/rules/, AGENTS.md, README.md, and Diátaxis docs/ trees (root + nested for monorepos). Four modes: init scaffolds a tiered docs setup from scratch; update detects drift (dead @imports, renamed commands, stale narrative) and incrementally refreshes via a Placement Resolver that pushes rules to the innermost-ancestor destination; readme writes or audits a README against the standard-readme spec; audit produces a documentation health report across every surface. Routes by kind: hard rules to CLAUDE.md, path-scoped patterns to .claude/rules/, narrative to docs/, marketing to README.md. Triggers on "init claude", "bootstrap docs", "scaffold CLAUDE.md", "update docs", "sync CLAUDE.md", "docs drift", "write a README", "audit our docs", "review the README", "Diátaxis", "/documentation".

4 Updated 2 days ago
mthines
AI & Automation Listed

update-docs-command

Run the `platform-dev-team-common:update-docs` workflow from the original Claude slash command. Use when the user asks to manually triggers documentation analysis and updates. Scans repository for outdated documentation and generates Mermaid charts for architectural changes.

1 Updated 4 days ago
datamaker-kr
AI & Automation Solid

doc-audit

Audit Packmind end-user documentation (apps/doc/) for broken links, outdated CLI references, non-existent concepts, misleading information, and missing coverage. Produces a structured markdown report at project root. Use when docs may have drifted from the codebase, before a release, or on a regular cadence.

287 Updated today
PackmindHub