An automated documentation engine that generates professional READMEs, API references, and code comments across multiple programming languages.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install rupert-code-documentor
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 rupert-code-documentor 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 Documentor Skill?
The Code Documentor skill is an essential addition to any developer's toolkit, providing automated documentation capabilities within the Openclaw Skills ecosystem. It simplifies the process of creating and maintaining technical documentation by analyzing source code and generating structured Markdown, HTML, or PDF files. By leveraging advanced AI analysis, it ensures that your code remains clear, maintainable, and professional without manual effort.
Designed to support a wide array of languages including Python, JavaScript, Swift, and Rust, this skill helps teams stay synchronized. Using Openclaw Skills for documentation means following best practices such as including examples, adding type hints, and documenting parameters according to language-specific conventions like those from Google or Stripe.
Code Documentor Skill Use Cases
- Rapidly creating a README.md for new projects to improve onboarding.
- Generating comprehensive API documentation for RESTful endpoints.
- Adding missing docstrings and function explanations to existing codebases.
- Producing architecture overviews and contributing guides for open-source contributions.
How Code Documentor Skill Works
- The AI agent scans the project directory or specific code files to interpret the logic.
- It maps out functions, parameters, return types, and class structures.
- The skill applies pre-defined templates based on the user's chosen documentation style.
- Documentation is synthesized into clear, readable sections like installation, usage, and API reference.
- The final content is exported to the specified format for immediate use in the project.
Code Documentor Skill Setup
Integrating the Code Documentor into your Openclaw Skills setup is straightforward. You can invoke the documentation engine using simple natural language commands in your CLI.
# Standard project documentation
openclaw run "document this code"
# Target specific components
openclaw run "create API docs for /v1/auth endpoint"
Code Documentor Skill Data Schema & Taxonomy
The Code Documentor organizes output data into logical segments to ensure high readability and SEO value.
| Data Type | Description | Key Elements |
|---|---|---|
| Project Info | General overview | Name, Description, Installation |
| API Schema | Endpoint mapping | Method, Path, Params, Description |
| Logic Documentation | In-depth code analysis | Function signatures, Args, Returns, Raises |
| Structural Docs | Project layout | Architecture docs, File trees |
Code Documentor Skill Advanced Features
- Configurable documentation styles tailored for Google, Stripe, or default formats.
- Support for multi-language environments including Go, Java, and TypeScript.
- Automated example generation to demonstrate code usage in generated docs.
- Versatile output options providing Markdown for Git and PDF/HTML for stakeholders.
SKILL.md
Loading
Related Openclaw Skills
Tencent Cloud FaceID DetectFace
A professional-grade face detection skill utilizing the Tencent Cloud IAI API to extract precise facial coordinates, attributes, and quality metrics from images.
Health Data Reviewer
A non-diagnostic health data organizer that synthesizes wearable exports and personal logs into structured summaries.
QR Code Generation and Recognition
A technical skill to generate customized, template-based QR codes and recognize data from images using the JisuAPI.
Retention Drop Checker
A diagnostic tool designed to pinpoint why short-form videos lose viewers and provide actionable script improvements.
Task Progress Report
A specialized skill for tracking and reporting the status of long-duration AI agent tasks through automated summaries and detailed markdown logs.
Intervals.icu CLI
A professional CLI tool for managing Intervals.icu activities, workouts, calendar events, and wellness metrics through automated workflows.
Featured*
