Skip to content
TrustedSkillsbeta
Back to all skills

code-documentation

Checked
skillcreatorai·v1.0.0·writing·MIT

Writing effective code documentation - API docs, README files, inline comments, and technical guides. Use for documenting codebases, APIs, or writing developer guides.

Install on your platform

Showing OpenClaw.

  1. 1

    Run this in your terminal

    terminal
    $

What we know about this skill

Publisher

skillcreatorai

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.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

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 skillcreatorai/ai-agent-skills at 6d95c788aa.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
6d95c788aa
Manifest
skills/code-documentation/SKILL.md
Scanned
1 file, 251 lines
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

This skill generates comprehensive code documentation, including API documentation, README files, inline code comments, and full technical guides. It can be used to explain complex codebases, detail API functionality for developers, or create detailed user manuals. The output is designed to improve code maintainability and developer understanding.

When to use it

  • Generating a README file: Quickly create an initial README for a new project outlining its purpose, installation instructions, and usage examples.
  • Documenting API endpoints: Automatically generate documentation describing the parameters, responses, and functionality of individual API endpoints.
  • Adding inline comments to code: Have the skill analyze existing code and suggest relevant comments explaining specific logic or algorithms.
  • Creating a technical guide for users: Produce step-by-step instructions and explanations for using a software product or library.

Key capabilities

  • API documentation generation
  • README file creation
  • Inline code commenting
  • Technical guide writing

Example prompts

  • "Generate a README file for my Python project, which is a web scraper for news articles."
  • “Write API documentation for the /users endpoint, including request parameters and example responses.”
  • "Add inline comments to this JavaScript function explaining how it calculates Fibonacci numbers: [paste code here]"

Tips & gotchas

The quality of the generated documentation depends heavily on the clarity and structure of the underlying code. Providing context about the intended audience (e.g., experienced developers vs. end-users) can also improve results.