/**
* Brief description.
*
* @param name - Parameter description
* @returns Return value description
* @throws {Error} When this happens
*/
API Documentation
## POST /api/endpoint
Description of what it does.
### Request
### Response
### Errors
Output
Generate documentation that is:
Accurate to the code
Concise but complete
Following existing patterns
1---2name: docs3description: Generate documentation4---56Generate documentation for specified code.78## Usage910- `/docs lib/rag.ts` - Document specific file11- `/docs api` - Document API endpoints12- `/docs` - Update CLAUDE.md1314## Documentation Types1516### JSDoc for Functions17```typescript18/**19 * Brief description.20 *21 * @param name - Parameter description22 * @returns Return value description23 * @throws {Error} When this happens24 */25```2627### API Documentation28```markdown29## POST /api/endpoint3031Description of what it does.3233### Request34### Response35### Errors36```3738## Output3940Generate documentation that is:41- Accurate to the code42- Concise but complete43- Following existing patterns
Run npx skillmds@latest add mgoodman60/docs in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
Generate documentation It is listed under Docs & Writing on SkillMD.
This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
mgoodman60 (@mgoodman60) published this skill. Their other Agent Skills are listed on their SkillMD profile.
mgoodman60