Setup & Installation
openclaw skills install @seanwyngaard/technical-doc-generator
Or with the ClawHub CLI, for registry-managed skill folders outside a full OpenClaw workspace:
npx clawhub install technical-doc-generator
What This Skill Does
Scans a local codebase and generates technical documentation across five formats: API docs, READMEs, architecture overviews, changelogs, and developer onboarding guides. Run it with a path and a doc type argument, or use 'full' to produce the complete set in a docs/ directory.
Covers all common documentation types in a single command rather than requiring separate tools or manual effort for each format.
When to use it
- Documenting a REST API before client handoff
- Writing a README for a new open source repo
- Building an onboarding guide for an incoming developer
- Generating a structured changelog from git commit history
- Producing an architecture overview for a codebase audit
Example Workflow
Here's how your AI assistant might use this skill in practice.
INPUT
User asks: /technical-doc-generator ./src api-docs
AGENT
- 1Scans package files and config to identify the project stack
- 2Detects the API framework (Express, FastAPI, Django, etc.)
- 3Extracts routes, methods, parameters, and request/response bodies
- 4Generates an OpenAPI YAML spec and a human-readable Markdown file
- 5Saves output to output/docs/ and presents a summary
OUTPUT
API.md with endpoint documentation and openapi.yaml saved to output/docs/