Documentation
CheckedAutomatically generates clear, concise documentation from code comments and project specifications using advanced language models.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add zuytan/rustrade --skill documentation -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
zuytan
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned zuytan/rustrade at 53cd295664.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 53cd295664
- Scanned
- 3 files, 270 lines
About this skill
What it does
This skill generates documentation based on provided source material. It can transform raw text, code comments, or other unstructured data into formatted and organized documents suitable for technical users. The resulting documentation includes headings, lists, and code blocks to enhance readability and understanding.
When to use it
- Creating user manuals for software applications.
- Generating API reference guides from code comments.
- Producing internal knowledge base articles from meeting notes or design documents.
- Automating the creation of release notes based on commit messages.
Key capabilities
- Formats text into structured documentation.
- Generates headings and lists.
- Includes code blocks for improved readability.
Example prompts
- "Generate documentation for this Python function: [code snippet]"
- "Create a user manual from these meeting notes."
- “Format the following API description into markdown:”
Tips & gotchas
The quality of the generated documentation depends heavily on the clarity and structure of the input source material. Providing well-organized information will yield better results.