← Back to Skills Marketplace
464
Downloads
0
Stars
2
Active Installs
1
Versions
Install in OpenClaw
/install code-documenter
Description
Use when adding docstrings, creating API documentation, or building documentation sites. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, tutorials, use...
README (SKILL.md)
Code Documenter
Documentation specialist for inline documentation, API specs, documentation sites, and developer guides.
Role Definition
You are a senior technical writer with 8+ years of experience documenting software. You specialize in language-specific docstring formats, OpenAPI/Swagger specifications, interactive documentation portals, static site generation, and creating comprehensive guides that developers actually use.
When to Use This Skill
- Adding docstrings to functions and classes
- Creating OpenAPI/Swagger documentation
- Building documentation sites (Docusaurus, MkDocs, VitePress)
- Documenting APIs with framework-specific patterns
- Creating interactive API portals (Swagger UI, Redoc, Stoplight)
- Writing getting started guides and tutorials
- Documenting multi-protocol APIs (REST, GraphQL, WebSocket, gRPC)
- Generating documentation reports and coverage metrics
Core Workflow
- Discover - Ask for format preference and exclusions
- Detect - Identify language and framework
- Analyze - Find undocumented code
- Document - Apply consistent format
- Report - Generate coverage summary
Reference Guide
Load detailed guidance based on context:
| Topic | Reference | Load When |
|---|---|---|
| Python Docstrings | references/python-docstrings.md |
Google, NumPy, Sphinx styles |
| TypeScript JSDoc | references/typescript-jsdoc.md |
JSDoc patterns, TypeScript |
| FastAPI/Django API | references/api-docs-fastapi-django.md |
Python API documentation |
| NestJS/Express API | references/api-docs-nestjs-express.md |
Node.js API documentation |
| Coverage Reports | references/coverage-reports.md |
Generating documentation reports |
| Documentation Systems | references/documentation-systems.md |
Doc sites, static generators, search, testing |
| Interactive API Docs | references/interactive-api-docs.md |
OpenAPI 3.1, portals, GraphQL, WebSocket, gRPC, SDKs |
| User Guides & Tutorials | references/user-guides-tutorials.md |
Getting started, tutorials, troubleshooting, FAQs |
Constraints
MUST DO
- Ask for format preference before starting
- Detect framework for correct API doc strategy
- Document all public functions/classes
- Include parameter types and descriptions
- Document exceptions/errors
- Test code examples in documentation
- Generate coverage report
MUST NOT DO
- Assume docstring format without asking
- Apply wrong API doc strategy for framework
- Write inaccurate or untested documentation
- Skip error documentation
- Document obvious getters/setters verbosely
- Create documentation that's hard to maintain
Output Formats
Depending on the task, provide:
- Code Documentation: Documented files + coverage report
- API Docs: OpenAPI specs + portal configuration
- Doc Sites: Site configuration + content structure + build instructions
- Guides/Tutorials: Structured markdown with examples + diagrams
Knowledge Reference
Google/NumPy/Sphinx docstrings, JSDoc, OpenAPI 3.0/3.1, AsyncAPI, gRPC/protobuf, FastAPI, Django, NestJS, Express, GraphQL, Docusaurus, MkDocs, VitePress, Swagger UI, Redoc, Stoplight
Usage Guidance
This skill appears coherent for generating and improving documentation. Before installing or invoking it: (1) Only grant it access to the project files you want documented — don't expose system-wide files. (2) Do not paste real API keys, private keys, or production secrets into prompts or code examples; use placeholders instead. (3) Be aware that the skill's guideline to 'test code examples' could imply executing code — run tests in an isolated/sandboxed environment if you allow execution. (4) Review any automated edits or generated docs before committing them to your repository. If you need the skill to run code or access CI/credentials, require an explicit, auditable workflow and temporary credentials scoped to test environments.
Capability Analysis
Type: OpenClaw Skill
Name: code-documenter
Version: 0.1.0
The 'code-documenter' skill bundle is a legitimate tool designed to assist in generating software documentation, API specifications, and user guides. It contains comprehensive reference materials and templates for various frameworks (FastAPI, NestJS, Django) and documentation systems (Docusaurus, MkDocs). The instructions in SKILL.md are strictly focused on documentation tasks, and no evidence of malicious intent, data exfiltration, or unauthorized execution was found across any of the files.
Capability Assessment
Purpose & Capability
Name/description (code documentation, API docs, doc sites) match the packaged content: a large SKILL.md and framework-specific reference docs. The skill requests no binaries, env vars, or installs — which is proportionate for a purely advisory/document generation skill.
Instruction Scope
Runtime instructions describe discovering format, detecting language/framework, finding undocumented code, documenting it, and testing examples. Reading and analyzing a codebase is expected for this skill, but 'Test code examples in documentation' can imply executing code or requiring runtime environment details; the skill text itself does not instruct indiscriminate reading of unrelated system files or exfiltration.
Install Mechanism
No install spec and no code files to execute — this is the lowest-risk pattern for skills. Everything is instruction-only documentation and references.
Credentials
The skill does not declare any required environment variables or credentials. Several example snippets in the reference files show use of API_KEY or PRIVATE_KEY in examples (placeholders). Those are normal examples but could encourage providing secrets to test examples — only provide secrets if you intend the agent to run code in a trusted, isolated environment.
Persistence & Privilege
always is false, agent invocation is normal, and the skill does not request persistent system-wide privileges or modify other skills' configs.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install code-documenter - After installation, invoke the skill by name or use
/code-documenter - Provide required inputs per the skill's parameter spec and get structured output
Version History
v0.1.0
Initial release of the code-documenter skill.
- Provides documentation support for docstrings, API specs (OpenAPI/Swagger), documentation sites, and developer guides.
- Includes a senior technical writer role definition and detailed workflow from discovery to coverage reporting.
- Supports multiple frameworks and languages, with references for specific docstring and API documentation styles.
- Enforces best practices: asks for format, detects framework, covers errors, and generates coverage reports.
- Outputs include code documentation, API specs, site configs, and structured guides/tutorials.
- MIT licensed and related to skills like spec-miner, fullstack-guardian, and code-reviewer.
Metadata
Frequently Asked Questions
What is Code Documenter?
Use when adding docstrings, creating API documentation, or building documentation sites. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, tutorials, use... It is an AI Agent Skill for Claude Code / OpenClaw, with 464 downloads so far.
How do I install Code Documenter?
Run "/install code-documenter" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Code Documenter free?
Yes, Code Documenter is completely free (open-source). You can download, install and use it at no cost.
Which platforms does Code Documenter support?
Code Documenter is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Code Documenter?
It is built and maintained by lhwa8685 (@lhwa8685); the current version is v0.1.0.
More Skills