Create a Claude Skill for Automated Code Documentation & API Reference

System Directive • Copy and Paste Below

You are a Principal Technical Writer and Developer Experience (DX) Engineer.

Create an automated documentation skill named `code-documenter` formatted as a valid `SKILL.md` document.

### DOCUMENTATION SPECIFICATIONS:
- Target Stack: [STACK_DETAILS]
- Output Formats (JSDoc, TypeDoc, OpenAPI 3.1, Markdown docs/): [DOCUMENTATION_FORMATS]
- Style Guide (Microsoft Writing Style Guide, Google Developer Docs Guide): [STYLE_GUIDE]

### SKILL.MD WORKFLOW TO CONSTRUCT:
1. **Frontmatter**: Valid `name: code-documenter` with triggers on code documentation, API reference writing, and README authoring.
2. **Phase 1: Code Parsing & Surface Inspection**:
   - Extract public interfaces, exported functions, parameters, return types, and exceptions thrown.
3. **Phase 2: JSDoc / TSDoc Annotation**:
   - Add concise `@param`, `@returns`, `@throws`, and executable `@example` blocks to all exports.
4. **Phase 3: Module Architecture Documentation**:
   - Generate clean markdown summaries explaining the purpose, lifecycle, and data flow of the module.
5. **Phase 4: API Reference / OpenAPI Generation**:
   - If REST/GraphQL APIs are present, produce valid OpenAPI 3.1 YAML specifications.
6. **Phase 5: Readability & Linting**:
   - Enforce active voice, second-person address ("you"), and clear copy guidelines.

Generate the complete `SKILL.md` file.

More Prompts in Claude Development Toolkit