Doc Forge is an intelligent documentation engine that analyzes source code to generate professional READMEs, API references, and architectural overviews.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install shadows-doc-forge
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 shadows-doc-forge 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 Doc Forge?
Doc Forge is a specialized utility within the Openclaw Skills ecosystem designed to eliminate the burden of manual technical writing. By performing a deep analysis of your codebase, it understands frameworks, data flows, and public interfaces to produce high-quality, Markdown-formatted documentation that accurately reflects the current state of your project.
This skill is particularly valuable for teams that struggle with outdated docs or missing onboarding materials. It doesn't just describe the code; it synthesizes the underlying logic to provide context-rich READMEs and architecture diagrams. By integrating Doc Forge into your workflow, you ensure that your documentation remains a living, accurate asset rather than a stale artifact.
Doc Forge Use Cases
- Generating a comprehensive README.md for a new or existing repository.
- Automating API documentation including endpoint methods, parameters, and response schemas.
- Creating high-level architecture documents with system diagrams for stakeholder review.
- Adding meaningful inline code comments that explain the logic behind complex edge cases.
- Standardizing documentation quality across large, multi-module development projects.
How Doc Forge Works
- Scans the project directory to identify key entry points, configuration files, and testing suites.
- Reads the source code to identify utilized frameworks, architectural patterns, and internal dependencies.
- Analyzes the logical flow of data and the structure of public-facing interfaces.
- Synthesizes documentation based on predefined templates for READMEs, API docs, or system overviews.
- Verifies all generated code snippets and function signatures against the actual source files to ensure technical accuracy.
Doc Forge Setup
As a lightweight component of Openclaw Skills, Doc Forge requires no external binaries or complex environment configurations. It operates directly on your local source files.
# Standard usage to generate a project README
openclaw run doc-forge "generate README for this project"
# Targeted documentation for API modules
openclaw run doc-forge "document all API endpoints in /src/api"
Doc Forge Data Schema & Taxonomy
Doc Forge organizes its output into clean, structured Markdown files. It maps data according to the following taxonomy:
| Document Type | Standard Filename | Key Metadata Fields |
|---|---|---|
| Project Overview | README.md | Installation, Features, Usage, License |
| API Reference | API.md | Methods, Auth, Parameters, Response Codes |
| System Design | ARCHITECTURE.md | Component Maps, Data Flow, Key Decisions |
| Inline Docs | N/A (Source Files) | Logic Explanations, Contracts, Edge Cases |
Doc Forge Advanced Features
- Automatic generation of ASCII or Mermaid-based system diagrams for visual architecture overviews.
- Logic-first inline commenting that prioritizes explaining the "Why" over the "What" to reduce noise.
- Language-aware generation that detects and matches the natural language (e.g., English, French) used in existing docs.
- Validation engine that cross-references documentation examples with live code to prevent drift.
- Template-based outputs that ensure consistency across different types of technical documentation.
SKILL.md
Loading
Related Openclaw Skills
Deploy Guardian
An automated 6-gate verification system designed to validate code health and security before any production or staging deployment.
Deep Research Protocol
A rigorous 4-round reasoning protocol designed to guide AI agents through exhaustive landscape mapping, risk assessment, and strategic synthesis.
Context Optimizer
Context Optimizer is a token economy protocol designed to reduce redundancy and prioritize critical context for AI agents.
Bug Hunter
A multi-technique debugging protocol for AI agents designed to triage, investigate, and fix software defects with a mandatory cleanup guarantee.
MCP Forge
A specialized tool for building Model Context Protocol (MCP) servers in Python or TypeScript to connect external services with AI agents.
Oneshot Fix (Surgical Quick Fix)
A high-speed, surgical repair protocol for AI agents to fix small bugs and typos with minimal tool interaction.
Featured*
