@ubuligan/code-documentation-generator
v1.0.0
Published
Generates professional Markdown documentation (README.md, API_DOCS.md, optional IMPLEMENTATION_NOTES.md) from source code in any language. Analyzes classes, functions, parameters, return types and thrown errors to produce CI/CD-ready docs. Use when the us
Maintainers
Readme
@ubuligan/code-documentation-generator
A Claude Code skill that auto-generates professional Markdown documentation from your source code.
Install
npx @ubuligan/code-documentation-generatorThen restart Claude Code so it picks up the skill.
Other installer commands:
npx @ubuligan/code-documentation-generator --list # show install status
npx @ubuligan/code-documentation-generator --force # overwrite existing
npx @ubuligan/code-documentation-generator --uninstall # remove the skillHow to use
In Claude Code, run:
/code-documentation-generatorGive it a code file path or paste a snippet (any language — JavaScript, TypeScript, Python, Go, …). It analyzes the public surface and generates ready-to-commit docs.
What it does
- Gets the source — reads a file you name or uses a snippet you paste.
- Analyzes the code — finds classes, functions, methods, parameters, return types, thrown errors and side effects.
- Generates
README.md— summary, installation, basic usage, features. - Generates
API_DOCS.md— per-method docs: parameters table, returns, throws, usage examples. - Generates
IMPLEMENTATION_NOTES.md(optional) — security notes, best practices, prioritized improvements. - Delivers — writes the Markdown files, CI/CD-ready and safe to push to GitHub.
License
MIT © 2026 Javid Salimov
