An AI-powered documentation specialist that generates standardized docstrings, comprehensive API specifications, and full developer portals.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install code-documenter
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install code-documenter using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Code Documenter?
Code Documenter is a professional-grade technical writing assistant designed to integrate seamlessly into your development workflow. As part of the Openclaw Skills ecosystem, it leverages years of technical writing expertise to produce documentation that is both accurate and developer-friendly. It handles everything from inline JSDoc or Python docstrings to high-level architecture diagrams and interactive API portals.
By using this specific tool from the Openclaw Skills library, developers can ensure their projects meet high quality standards without the manual overhead typically associated with documentation. It acts as a senior technical writer that understands the nuances of different frameworks like FastAPI, NestJS, and Django, ensuring that your documentation remains synchronized with your implementation.
Code Documenter Use Cases
- Automatically adding docstrings to public functions and classes to improve maintainability.
- Generating OpenAPI or Swagger specifications for REST and GraphQL APIs.
- Building and organizing documentation sites using Docusaurus, MkDocs, or VitePress.
- Creating interactive developer portals with Swagger UI, Redoc, or Stoplight configurations.
- Writing getting started guides and tutorials with live, tested code examples.
How Code Documenter Works
- Discovery Phase: The skill queries the user for preferred documentation formats (e.g., Google vs. NumPy styles) and any exclusion rules.
- Environment Detection: It automatically identifies the programming language and framework to apply the correct API documentation strategy.
- Code Analysis: The agent scans the codebase to locate undocumented public members and API endpoints.
- Implementation: It applies consistent documentation formatting across all targeted files while ensuring parameter types and exceptions are included.
- Reporting: The skill generates a final coverage report to summarize the documentation status and overall project health.
Code Documenter Setup
To get started with this skill, ensure you have the core environment configured. Use the following commands to integrate it into your workflow:
# Install the code-documenter skill
openclaw install code-documenter
# Configure your preferred docstring style (e.g., JSDoc or Google)
openclaw config code-documenter --style google
Code Documenter Data Schema & Taxonomy
The Code Documenter skill organizes its output into structured files and inline metadata based on the following schema:
| Component | Format | Details |
|---|---|---|
| Inline Docs | String | Standardized docstrings (JSDoc, Google, Sphinx) |
| API Specs | JSON/YAML | OpenAPI 3.1 or AsyncAPI specifications |
| Guides | Markdown | Structured tutorials with metadata headers |
| Coverage | JSON | Reports tracking percentage of documented code |
Code Documenter Advanced Features
- Multi-protocol API support including REST, GraphQL, WebSocket, and gRPC definitions.
- Automated generation of documentation coverage metrics to identify technical debt.
- Framework-specific deep integration for NestJS, Express, FastAPI, and Django.
- Integration with Openclaw Skills to support cross-agent documentation workflows.
- Support for static site generator (SSG) scaffolding and configuration management.
SKILL.md
Loading
Related Openclaw Skills
Cloud Architect
A senior-level AI skill for designing, migrating, and optimizing multi-cloud infrastructures across AWS, Azure, and GCP.
Chaos Engineer
A specialized AI agent skill for designing controlled failure experiments, managing blast radius, and building antifragile systems.
AI Trainer & Learning Specialist
An automated knowledge acquisition skill that fetches technical documentation and integrates insights directly into your agent's memory and operational rules.
CosyVoice3
A powerful local text-to-speech engine by Alibaba optimized for macOS Apple Silicon with advanced zero-shot voice cloning and dialect support.
C++ Pro
A senior-level engineering skill for developing high-performance, memory-safe applications using modern C++20/23 standards.
C# Developer
A specialist skill for building modern .NET 8+ applications, cloud-native APIs, and Blazor web apps with senior-level architecture patterns.
Featured*
