← Back to Skills Marketplace
Reference Docs
by
Kevin Anderson
· GitHub ↗
· v1.0.1
· MIT-0
130
Downloads
0
Stars
1
Active Installs
2
Versions
Install in OpenClaw
/install reference-docs
Description
Reference documentation patterns for API and symbol documentation. Use when writing reference docs, API docs, parameter tables, or technical specifications....
Usage Guidance
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.
Capability Analysis
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.
Capability Tags
Capability Assessment
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.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install reference-docs - After installation, invoke the skill by name or use
/reference-docs - Provide required inputs per the skill's parameter spec and get structured output
Version History
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.
Metadata
Frequently Asked Questions
What is Reference Docs?
Reference documentation patterns for API and symbol documentation. Use when writing reference docs, API docs, parameter tables, or technical specifications.... It is an AI Agent Skill for Claude Code / OpenClaw, with 130 downloads so far.
How do I install Reference Docs?
Run "/install reference-docs" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Reference Docs free?
Yes, Reference Docs is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Reference Docs support?
Reference Docs is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Reference Docs?
It is built and maintained by Kevin Anderson (@anderskev); the current version is v1.0.1.
More Skills