Document
Use when the user wants to add documentation, JSDoc, docstrings, or API docs to existing code.
Install
$ agentstack add skill-huzaifa525-claude-code-optimizer-document ✓ scanned · ✓ verified — works with Claude Code, Cursor, and more.
Security review
✓ PassedNo issues found. Passed automated security review. · v0.1.0 How review works →
- ✓ Prompt-injection patterns
- ✓ Secret / credential exfiltration
- ✓ Dangerous shell & filesystem operations
- ✓ Untrusted network calls
- ✓ Known-malicious package signatures
What it can access
- ✓ Network access No
- ✓ Filesystem access No
- ✓ Shell / process execution No
- ✓ Environment & secrets No
- ✓ Dynamic code execution No
From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.
About
Document: $ARGUMENTS
Steps
- Detect the language and doc style
- Check existing docs in the codebase for style
- TypeScript/JavaScript → JSDoc or TSDoc
- Python → Google-style docstrings
- Go → godoc comments
- Rust →
///doc comments - Match whatever style already exists
- Read the code thoroughly — understand every function, class, and type
- Add documentation for:
| Element | What to Document | |---------|-----------------| | Functions | Purpose, params, return value, throws, example | | Classes | Purpose, usage pattern | | Interfaces/Types | What it represents, field descriptions | | Constants | Why this value | | Complex logic | Step-by-step explanation | | Module/File | Top-level description of what this file does |
- Rules
- Document the WHY, not the WHAT (code already shows what)
- Keep descriptions concise — one line if possible
- Include
@examplefor non-obvious usage - Don't document getters/setters or trivial functions
- Match existing doc style in the codebase exactly
- Verify — ensure no code was accidentally changed
`` git diff --stat ``
Source & license
This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.
- Author: huzaifa525
- Source: huzaifa525/claude-code-optimizer
- License: MIT
- Homepage: https://www.npmjs.com/package/claude-code-optimizer
Install and usage instructions live in the source repository linked above.
Reviews
No reviews yet — be the first.
Write a review
Versions
- v0.1.0 Imported from the upstream source.