Skip to content
TrustedSkillsbeta
Back to all skills

Code Documentation

Checked
aj-geddes·vlatest·writing·MIT

Generates clear, concise code documentation from existing code, adhering to common standards and improving readability.

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 aj-geddes/useful-ai-prompts --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

aj-geddes

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 aj-geddes/useful-ai-prompts at 3f5182cfd7.

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

Commit
3f5182cfd7
Manifest
skills/code-documentation/SKILL.md
Scanned
8 files, 523 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 instructs AI agents to generate clear, structured documentation for codebases, functions, or specific logic blocks. It transforms raw source code into readable explanations that highlight purpose, inputs, outputs, and usage patterns.

When to use it

  • You need to onboard new developers to an existing project without reading every line of code manually.
  • You want to create API reference guides or function signatures for a library you are building.
  • You need to explain complex algorithms or legacy systems to stakeholders who lack technical backgrounds.
  • You are preparing code for open-source publication and require standard README or docstring formats.

Key capabilities

  • Analyzes source code files to extract logic and dependencies.
  • Generates human-readable summaries of function behavior and parameters.
  • Produces structured documentation suitable for Markdown, JSDoc, or Python docstrings.
  • Identifies edge cases and potential usage scenarios within the provided code context.

Example prompts

  • "Analyze this Python script and write a comprehensive README explaining its main features and how to run it."
  • "Generate detailed JSDoc comments for every function in this JavaScript module, including parameter descriptions and return values."
  • "Explain the logic behind this specific algorithm in plain English, focusing on how data flows through the system."

Tips & gotchas

Ensure you provide the full relevant code context or a representative sample; fragmented snippets may lead to incomplete explanations. While the skill excels at summarizing existing logic, it cannot infer undocumented business rules that are not explicitly visible in the code structure.