document
Update documentation, READMEs, and add JSDoc/TypeDoc.
12 stars
Best use case
document is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Update documentation, READMEs, and add JSDoc/TypeDoc.
Teams using document should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
$curl -o ~/.claude/skills/document/SKILL.md --create-dirs "https://raw.githubusercontent.com/lionbenjamin/agent-templates/main/skills/document/SKILL.md"
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/document/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How document Compares
| Feature / Agent | document | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Update documentation, READMEs, and add JSDoc/TypeDoc.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# Document Skill User-centric documentation and technical writing. ## When to Activate This skill is relevant when: - Code changes require documentation updates - Public APIs need documentation - README needs updating - Adding inline code comments - Creating technical guides - Updating architecture docs ## Core Principles ### Clarity - Explain *why*, not just *what* - Write for the target audience - Use clear, simple language - Avoid jargon where possible - Provide context and rationale ### Accuracy - Code changes reflected in docs immediately - Keep documentation in sync with code - Verify all examples work - Update outdated sections - Test documentation accuracy ### Completeness - No public API left undocumented - Cover all user-facing features - Document edge cases and limitations - Include examples and use cases - Provide troubleshooting guidance ### User-Centric - Write for developers using the code - Consider different skill levels - Provide practical examples - Answer common questions - Make it easy to get started ## Quick Checks For documentation updates, verify: - [ ] README "Getting Started" is current - [ ] Public functions have JSDoc/TypeDoc - [ ] API documentation is complete - [ ] Code examples are tested and working - [ ] Architecture descriptions are accurate - [ ] Diagrams reflect current state - [ ] Links are valid and working - [ ] Markdown renders correctly - [ ] Complex logic has inline comments - [ ] Breaking changes documented - [ ] Migration guides provided - [ ] Configuration options documented - [ ] Environment variables listed - [ ] Dependencies documented - [ ] Changelog updated ## Documentation Types ### README - Getting Started guide - Installation instructions - Basic usage examples - Configuration overview ### API Documentation - Function signatures - Parameter descriptions - Return value documentation - Usage examples ### Inline Documentation - JSDoc/TypeDoc comments - Complex logic explanations - Algorithm descriptions - Edge case notes ### Architecture Documentation - System design - Component relationships - Data flow diagrams - Technical decisions
Related Skills
We are still matching the closest adjacent skills for this page. In the meantime, continue through the full directory.