Automated summary
Generates and updates technical documentation for code, APIs, and projects while matching the documentation style already established in the repository.
Strengths
- Automatically picks the right documentation format per language (JSDoc, docstrings, GoDoc, Rustdoc, Markdown)
- Greps existing doc comments to stay consistent with the project's format, detail level, and tone
- Re-reads the code to confirm parameter names, return types, and examples match real behavior
- Explicitly lists items needing manual review, such as ambiguous behavior or missing context
Limitations
- Does not handle multi-file documentation coordination, which is delegated to doc-orchestration
- Does not cover user-facing copy or UI text
- Example verification is a manual re-read; code blocks are not actually executed
Use it to add inline documentation, write or refresh a README, or document a specific function signature or API endpoint.
Avoid it when you need to coordinate docs across an entire repository or write end-user facing copy.
Security analysis
SafeThe skill is purely a documentation-writing guide constrained to Read, Write, Edit, Grep, and Glob. It contains no bash execution, network calls, credential handling, obfuscated payloads, or instructions to disable safety. File modification is limited to writing documentation content that the user explicitly requests, so execution risk is minimal.
No concerns found
How this analysis is madeExamples
Add JSDoc to the exported functions in src/utils/parse.ts, including params, return values, and a short usage example.Write a README for this project: one-line description, installation, quick start, usage, and configuration.Document the POST /api/orders endpoint in our Express router, listing the request body, responses, and error cases.name: documentation description: >- Generate and update technical documentation for code, APIs, and projects. Triggers on "document this", "add docs", "write a README", "add JSDoc", "generate API docs". NOT for multi-file doc coordination — use doc-orchestration. allowed-tools: Read, Write, Edit, Grep, Glob
When to Use
- Adding inline documentation (JSDoc, docstrings, GoDoc comments)
- Writing or updating a README
- Documenting an API endpoint or function signature
- Adding architecture or design documentation
When NOT to Use
- Coordinating docs across many files at once — use
doc-orchestration - Writing user-facing copy or UI text — use
copywriting - Creating an implementation plan — use
plan
Instructions
1. Detect What Needs Documentation
Read the target code or file. Determine the appropriate doc format:
| Language | Format | Example |
|----------|--------|---------|
| TypeScript/JavaScript | JSDoc | /** @param {string} name */ |
| Python | Docstrings | """Description.\n\nArgs:\n name: ...""" |
| Go | GoDoc | // FunctionName does X. |
| Rust | Rustdoc | /// Description |
| General | Markdown | README.md, docs/*.md |
2. Read Existing Documentation Style
Use Grep to find existing doc comments in the project. Match the format, level of detail, and tone already established. Check for a style guide in docs/ or CONTRIBUTING.md.
3. Write Documentation
Follow these principles:
- Lead with what and why, not how
- Keep descriptions concise — one sentence for simple items
- Document parameters, return values, and thrown errors
- Include a usage example for public APIs
- Note any side effects or important constraints
For README files:
- Start with project name and one-line description
- Include: installation, quick start, usage, configuration
- Add badges, links to full docs if applicable
4. Verify Accuracy
Re-read the code to confirm the documentation matches actual behavior. Check that:
- Parameter names and types are correct
- Return types match the implementation
- Examples compile/run if they are code blocks
Output
- List of files updated with documentation
- Summary of what was documented
- Any items that need manual review (ambiguous behavior, missing context)
From the file to a first result
The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.
View the source and supporting filesThis download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.
1. Download the file
Download SKILL.mdFrom the root of a test project, save the file as .skill-downloads/documentation-generator-mrx3xxwk/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.
Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.
mkdir -p '.skill-downloads/documentation-generator-mrx3xxwk' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/documentation-generator-mrx3xxwk/download' --output '.skill-downloads/documentation-generator-mrx3xxwk/SKILL.md.part' && mv '.skill-downloads/documentation-generator-mrx3xxwk/SKILL.md.part' '.skill-downloads/documentation-generator-mrx3xxwk/SKILL.md'2. Check prerequisites
Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.
Tools declared by the author (check availability in your agent): Read, Write, Edit, Grep, Glob
No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.
The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.
3. Load the skill
After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.
Claude Code
test -f '.skill-downloads/documentation-generator-mrx3xxwk/SKILL.md' && test -s '.skill-downloads/documentation-generator-mrx3xxwk/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/documentation' && cp -R '.skill-downloads/documentation-generator-mrx3xxwk' '.claude/skills/documentation'Cursor
test -f '.skill-downloads/documentation-generator-mrx3xxwk/SKILL.md' && test -s '.skill-downloads/documentation-generator-mrx3xxwk/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/documentation' && cp -R '.skill-downloads/documentation-generator-mrx3xxwk' '.cursor/skills/documentation'Codex
test -f '.skill-downloads/documentation-generator-mrx3xxwk/SKILL.md' && test -s '.skill-downloads/documentation-generator-mrx3xxwk/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/documentation' && cp -R '.skill-downloads/documentation-generator-mrx3xxwk' '.agents/skills/documentation'OpenSkills
OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.
Official OpenSkills installationopenskills install './.skill-downloads/documentation-generator-mrx3xxwk'openskills read 'documentation-generator-mrx3xxwk'Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.
For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.
openskills syncManual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.
4. Try a first task
Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:
Read .skill-downloads/documentation-generator-mrx3xxwk/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.
Supabase Docs Authoring
Documentation
Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.
Create Architecture Decision Record
Documentation
Create a new Architecture Decision Record with sequential numbering, register it in the AgentDB graph, and link related ADRs.
Plan update with deep research
Documentation
Updates a plan document by launching parallel subagents to analyze a topic across all compiler passes, then consolidates findings into the plan doc.