Cheggin/documentation-generator
skills/documentation-generator/SKILL.md
Auto-generate user-facing documentation including API reference, user guides, and changelog. Use when the user needs a documentation site, wants API docs generated from code comments and type definitions, needs user guides derived from a product spec, or wants a changelog generated from git history.
development
Updated Apr 25, 2026
$ install --global
skillsauthnpx skillsauth add Cheggin/skill-chain documentation-generatorInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 25, 2026, 8:36 PM30.0s1 file scanned
SKILL.md
- name:
- documentation-generator
- description:
- Auto-generate user-facing documentation including API reference, user guides, and changelog. Use when the user needs a documentation site, wants API docs generated from code comments and type definitions, needs user guides derived from a product spec, or wants a changelog generated from git history.
- user-invocable:
- true
- group:
- comms
- prerequisites:
- []
- next:
- [readme-generator]
- workflows:
- [full-startup]
Documentation Generator
Auto-generate user-facing documentation for the product: API reference from code, user guides from the product spec, and a changelog from git history. Documentation is published as part of the website or as a separate docs site and rebuilds on every deploy.
Workflow
1. Scaffold Documentation Site
Set up the docs infrastructure:
- Create the
/docsroute or separate subdomain - Build navigation with sidebar and breadcrumbs across all sections
- Add search functionality across all documentation pages
2. Generate API Reference
Parse code comments, JSDoc annotations, and TypeScript type definitions to produce API reference pages. Each endpoint or function page should include:
- Description and purpose
- Request parameters with types and constraints
- Response schema with examples
- Runnable code examples (curl, SDK snippets)
If the product has a public API, generate an OpenAPI/Swagger spec.
3. Generate User Guides
Read the product spec to identify major features and generate a user guide for each:
- Written in plain language for end users (not developer jargon)
- Step-by-step instructions with screenshots where applicable
- Common troubleshooting tips per feature
4. Generate Changelog
Parse git history using conventional commit format to produce a grouped changelog:
## v1.2.0 (2025-01-15)
### Features
- Add dark mode support (#123)
### Fixes
- Fix login redirect on mobile (#124)
### Breaking Changes
- Remove deprecated /v1/users endpoint (#125)
5. Cross-Link and Publish
- Link documentation from README, landing page, and in-app help
- Add versioning support for API breaking changes
- Configure docs to rebuild on every deploy to prevent stale content
Anti-Patterns
- API reference that lists endpoint names without request/response schemas or examples
- User guide written in developer jargon instead of plain language for end users
- Changelog that is a flat list of commit messages with no grouping or formatting
- Documentation that is manually maintained and goes stale after deployment
Related Skills
Cheggin/make-interfaces-feel-better
development
VerifiedTrustedCommunity
Design engineering principles for making interfaces feel polished. Use when building UI components, reviewing frontend code, implementing animations, hover states, shadows, borders, typography, micro-interactions, enter/exit animations, or any visual detail work. Triggers on UI polish, design details, "make it feel better", "feels off", stagger animations, border radius, optical alignment, font smoothing, tabular numbers, image outlines, box shadows.
1SKILL.mdUpdated Apr 29, 2026
Cheggin/writer-memory
documentation
VerifiedTrustedCommunity
Agentic memory system for writers - track characters, relationships, scenes, and themes
SKILL.mdUpdated Apr 25, 2026
Cheggin/wiki
documentation
VerifiedTrustedCommunity
LLM Wiki — persistent markdown knowledge base that compounds across sessions (Karpathy model)
SKILL.mdUpdated Apr 25, 2026
Cheggin/website-creation
development
VerifiedTrustedCommunity
Build production-quality SaaS websites with opinionated design presets. Use when creating any startup website. The user MUST pick a design style before building. Enforces shadcn/ui, Figma design principles, specific CSS values per style, and anti-AI-writing. Load alongside anti-ai-writing skill. LIGHT MODE ONLY.
SKILL.mdUpdated Apr 25, 2026