← 返回 Skills 市场
Reference Docs
作者
Kevin Anderson
· GitHub ↗
· v1.0.1
· MIT-0
130
总下载
0
收藏
1
当前安装
2
版本数
在 OpenClaw 中安装
/install reference-docs
功能描述
Reference documentation patterns for API and symbol documentation. Use when writing reference docs, API docs, parameter tables, or technical specifications....
安全使用建议
This skill is coherent and low-risk: it's a pattern/template guide for reference docs. Before using or publishing examples created with it, ensure you never embed real API keys, passwords, or production PII—use placeholders or environment-variable patterns and scrub example outputs. Also prefer safe example domains (example.com) and avoid showing live endpoints or credentials in published docs. Finally note the skill recommends pairing with a separate 'docs-style' skill; verify that dependent skill's behavior if you plan to enable both.
功能分析
Type: OpenClaw Skill
Name: reference-docs
Version: 1.0.1
The skill bundle provides templates and guidelines for generating technical reference documentation, such as API specifications and parameter tables. It contains no executable code, network requests, or instructions that could lead to data exfiltration or unauthorized actions. The content in SKILL.md is entirely focused on documentation style and structure.
能力标签
能力评估
Purpose & Capability
Name/description (reference docs) match the SKILL.md content. The instructions are documentation patterns and templates — nothing requests unrelated system access, binaries, or credentials.
Instruction Scope
The SKILL.md stays within documentation guidance. Minor issue: several runnable examples show using process.env.API_KEY and ask for 'realistic values' which may encourage authors to place sensitive values in examples; the skill itself does not instruct the agent to read or transmit user secrets.
Install Mechanism
No install spec and no code files — lowest-risk model. Nothing is downloaded or written to disk by the skill itself.
Credentials
The skill declares no required environment variables or credentials. However, examples reference process.env.API_KEY and recommend realistic values for examples (emails, IDs), which is a documentation-quality concern rather than a direct credential requirement.
Persistence & Privilege
always is false and the skill does not request persistent system privileges or modify other skills. Autonomous invocation is allowed (default) but is not combined with any elevated access here.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install reference-docs - 安装完成后，直接呼叫该 Skill 的名称或使用
/reference-docs触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.0.1
Version 1.0.1
- Added a new "Gates (completion order)" section outlining a sequenced checklist for reference documentation quality.
- Clarified that each major section must exist or have an explicit omission note.
- Defined "Pass" conditions for structure and table completeness.
- No other sections or content were changed.
v1.0.0
- Initial release of the reference-docs skill.
- Provides templates and patterns for writing clear, consistent API and symbol reference documentation.
- Includes structure templates for parameters, return values, API endpoints, UI component props, and related links.
- Emphasizes brevity, scannability, consistency, and realistic runnable examples.
- Designed for quick technical lookup by experienced users.
元数据
常见问题
Reference Docs 是什么？
Reference documentation patterns for API and symbol documentation. Use when writing reference docs, API docs, parameter tables, or technical specifications.... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 130 次。
如何安装 Reference Docs？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install reference-docs」即可一键安装，无需额外配置。
Reference Docs 是免费的吗？
是的，Reference Docs 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。
Reference Docs 支持哪些平台？
Reference Docs 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 Reference Docs？
由 Kevin Anderson（@anderskev）开发并维护，当前版本 v1.0.1。
推荐 Skills