Skip to content
TrustedSkillsbeta
Back to all skills

Auto Documentation

Checked
lgbarn·vlatest·writing·MIT

Automatically generates clear, concise documentation from code comments and function descriptions, saving developers time.

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 lgbarn/devops-skills --skill auto-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

lgbarn

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 lgbarn/devops-skills at 8a37cc3fe5.

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

Commit
8a37cc3fe5
Manifest
skills/auto-documentation/SKILL.md
Scanned
1 file, 286 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 automatically generates documentation from code. It's designed to reduce manual effort in creating and maintaining technical documentation, ensuring that documentation stays up-to-date with codebase changes. The generated documentation can be used for internal teams or public consumption.

When to use it

  • Onboarding new developers: Quickly provide new team members with clear documentation of existing codebases.
  • Automating API documentation: Generate and update API reference materials automatically.
  • Creating user guides: Produce basic user guides from code comments and function descriptions.
  • Maintaining internal knowledge bases: Keep internal wikis and documentation platforms synchronized with the latest code changes.

Key capabilities

  • Automatic generation of documentation
  • Codebase synchronization
  • Support for various programming languages (implied)
  • Documentation format customization (implied)

Example prompts

  • "Generate documentation for the src/api directory."
  • "Create API reference materials from all code comments."
  • "Update the internal wiki with the latest documentation."

Tips & gotchas

The quality of generated documentation depends heavily on clear and concise code comments. Ensure your codebase has sufficient commenting to maximize the skill's effectiveness.