Skip to content
TrustedSkillsbeta
Back to all skills

Code Documentation

Checked
skillcreatorai·vlatest·writing·MIT

Automatically generates clear, concise documentation comments for code functions and classes, boosting project maintainability.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add moizibnyousaf/ai-agent-skills --skill code-documentation -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

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 documentation for code. It can produce explanations of functions, classes, and modules, as well as API references. The generated documentation aims to be clear, concise, and suitable for both technical and non-technical audiences.

When to use it

  • Understanding unfamiliar codebases: Quickly generate documentation to grasp the purpose and functionality of existing code.
  • Creating API references: Automatically produce comprehensive API documentation from source code comments.
  • Onboarding new developers: Provide clear and accessible documentation for new team members joining a project.
  • Generating release notes: Extract key changes and improvements documented within the codebase to create concise release notes.

Key capabilities

  • Generates function/method descriptions
  • Creates class/module overviews
  • Produces API references
  • Supports various programming languages (implied)

Example prompts

  • "Generate documentation for this Python function: [code snippet]"
  • "Create an API reference for the 'users' module in my project."
  • “Explain what this class does: [code snippet]”

Tips & gotchas

The quality of generated documentation depends heavily on the clarity and completeness of existing code comments. Providing well-commented code will yield better results.