agentsclimarketplace

Document

Skill huzaifa525/claude-code-optimizer/templates/.claude/skills/document

Use when the user wants to add documentation, JSDoc, docstrings, or API docs to existing code.From its SKILL.md

Install
npx -y skills add huzaifa525/claude-code-optimizer --skill document

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

2 things to look at

  • 9 stars9 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
  • runs commandsInstructs the agent to run 1 command, including `git diff --stat`.

SKILL.md

1.5 KB, 312 tokens by cl100k_base, as published. Nobody here has run it

Document: $ARGUMENTS

Steps

  1. Detect the language and doc style

    • Check existing docs in the codebase for style
    • TypeScript/JavaScript → JSDoc or TSDoc
    • Python → Google-style docstrings
    • Go → godoc comments
    • Rust → /// doc comments
    • Match whatever style already exists
  2. Read the code thoroughly — understand every function, class, and type

  3. Add documentation for:

    ElementWhat to Document
    FunctionsPurpose, params, return value, throws, example
    ClassesPurpose, usage pattern
    Interfaces/TypesWhat it represents, field descriptions
    ConstantsWhy this value
    Complex logicStep-by-step explanation
    Module/FileTop-level description of what this file does
  4. Rules

    • Document the WHY, not the WHAT (code already shows what)
    • Keep descriptions concise — one line if possible
    • Include @example for non-obvious usage
    • Don't document getters/setters or trivial functions
    • Match existing doc style in the codebase exactly
  5. Verify — ensure no code was accidentally changed

    git diff --stat
    
<!-- Skill by Huzefa Nalkheda Wala | github.com/huzaifa525 | claude-code-optimizer -->

What ships with it

Read from the repository

Just SKILL.md. No reference files, no scripts.

Keep looking

Skills are one crate of 325,949. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.