← 返回 Skills 市场
464
总下载
0
收藏
2
当前安装
1
版本数
在 OpenClaw 中安装
/install code-documenter
功能描述
Use when adding docstrings, creating API documentation, or building documentation sites. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, tutorials, use...
使用说明 (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
安全使用建议
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.
功能分析
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.
能力评估
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.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install code-documenter - 安装完成后，直接呼叫该 Skill 的名称或使用
/code-documenter触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
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.
元数据
常见问题
Code Documenter 是什么？
Use when adding docstrings, creating API documentation, or building documentation sites. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, tutorials, use... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 464 次。
如何安装 Code Documenter？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install code-documenter」即可一键安装，无需额外配置。
Code Documenter 是免费的吗？
是的，Code Documenter 完全免费（开源免费），可自由下载、安装和使用。
Code Documenter 支持哪些平台？
Code Documenter 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 Code Documenter？
由 lhwa8685（@lhwa8685）开发并维护，当前版本 v0.1.0。
推荐 Skills