project-documentation

Solid

Creates and maintains project documentation for features, systems, and components. Discovers project structure dynamically to work across any technology stack. Use when documenting how a feature, system, or component works — including writing, updating, or organizing docs. Does not scan or detect the project's technology stack — use project-discovery for repository analysis and config detection. Does not create architectural decision records — use architectural-decision-record for ADRs. Does not create or update coding standards — use coding-standard instead. Does not generate PR descriptions — use update-pr-description for that. Does not produce runbooks for operational scenarios — use runbook for that.

Data & Documents 66 stars 5 forks Updated today MIT

Install

View on GitHub

Quality Score: 88/100

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

Skill Content

## Project Context - Git user: !`git config user.name` (!`git config user.email`) - OS username: !`whoami` - CLAUDE.md exists: !`find . -maxdepth 1 -name "CLAUDE.md" -type f` - project-discovery.md: !`find . -maxdepth 3 -name "project-discovery.md" -type f` # Project Documentation ## Step 1: Evaluate and Gather Context **Guard check:** If the request is about an **architectural decision**, suggest `architectural-decision-record` instead. If it's about a **coding convention**, suggest `coding-standard` instead. Proceed only after confirming this is project documentation. **Docs directory:** Resolve project config: read CLAUDE.md's `## Project Discovery` section for docs directory and language; fall back to project-discovery.md; fall back to Glob default (`docs/`). Use the found docs directory with Glob to enumerate existing `.md` files. If no docs directory was found, create `docs/`. The found language informs code fence language identifiers in Step 3. **Resolve target files:** Derive the filename in kebab-case: `docs/{feature-name}.md`. Use Glob to check if the file already exists (`docs/{feature-name}*.md`). If it exists, use `AskUserQuestion` to ask: update the existing document, or create with a different name? If not, it will be created. **Author info:** If git user or email is empty in the project context above, ask the user for their name and email. **Topic context:** Use the arguments and conversation context to understand the topic and scope. If unclear, use `...

Details

Author
testdouble
Repository
testdouble/han
Created
3 weeks ago
Last Updated
today
Language
Shell
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

API & Backend Solid

project-docs

Generate project documentation from codebase analysis — ARCHITECTURE.md, API_ENDPOINTS.md, DATABASE_SCHEMA.md. Reads source code, schema files, routes, and config to produce accurate, structured docs. Use when starting a project, onboarding contributors, or when docs are missing or stale. Triggers: 'generate docs', 'document architecture', 'create api docs', 'document schema', 'project documentation', 'write architecture doc'.

809 Updated 2 weeks ago
jezweb
Data & Documents Listed

docs

Generate or update project documentation following the AI-DLC documentation standard. Creates README.md, CHANGELOG.md, SECURITY.md, and docs/manuals/ with audience-specific guides.

1 Updated 1 months ago
msifoss
Data & Documents Listed

docs-manager

Documentation management workflow for MkDocs sites and standalone markdown files — initialize, generate, update docs, and create change summaries. Use when asked to "create docs", "write README", "update documentation", "generate docs site", "write CONTRIBUTING", "manage documentation", or "docs changelog".

38 Updated 1 months ago
sequenzia
Data & Documents Listed

documentation-authoring

Create structured docs from scratch — PRDs, technical specs, design docs, decision records, knowledge bases. Use when drafting documentation, writing proposals, defining requirements, or planning features.

1 Updated today
bg-szy
Data & Documents Listed

create-doc

Create documentation based on user needs. Use when writing guides, API docs, architecture docs, or any project documentation.

64 Updated 2 weeks ago
avibebuilder