Code Documenter

What it does

When your agent uses it

• Adding docstrings or JSDoc comments to undocumented functions and classes
• Writing or validating an OpenAPI or Swagger spec for a REST API
• Building a documentation site or a getting-started guide for a project

Example prompts

• “Add Google-style docstrings to every public function in this module.”
• “Write an OpenAPI spec for these three endpoints and validate it.”
• “Generate JSDoc comments for this TypeScript service class.”

Requirements

• Python, for doctest validation
• tsc, for TypeScript or JavaScript example validation
• npx @redocly/cli, for OpenAPI linting

Workflow steps

6 steps, taken from the first numbered list in SKILL.md.

1. 1Discover - Ask for format preference and exclusions
2. 2Detect - Identify language and framework
3. 3Analyze - Find undocumented code
4. 4Document - Apply consistent format
5. 5Validate - Test all code examples compile/run
6. 6Report - Generate coverage summary

What it can do on your machine

Read from SKILL.md and the folder at commit 1be15d8. It shows what the files ask for, not the result of running them.

• Tool permissions

  Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

  From allowed-tools in the SKILL.md frontmatter.

• Runs code

  Shell commands in SKILL.md call:

  • python
  • pytest
  • tsc
  • npx

  From the folder's file list and the shell code blocks in SKILL.md.

• Network

  Links to these hosts (documentation or services it may open):

  • github.com
  • synergetic.solutions
  • jeffallan.github.io

  From URLs in SKILL.md, links to its own repository left out.

• Credentials

  Names no API keys, tokens, secrets or passwords.

  From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Code Documenter loads about 1.5k tokens when it runs, and up to ~13k if it reads all its reference files. Until then it costs about 99 tokens; SKILL.md has 350 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it

~99

When it runs · the whole SKILL.md, loaded when a task matches

~1.5k

With references · SKILL.md plus every file in references/, read only if the agent opens them

~13k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from Jeffallan/claude-skills at commit 1be15d8, republished under its MIT licence (© Jeffallan). 350 words, ~1,452 tokens.

name

code-documenter

description

Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.

license

MIT

metadata.author

https://github.com/Jeffallan

metadata.company

https://synergetic.solutions

metadata.version

1.1.0

metadata.domain

quality

metadata.triggers

documentation, docstrings, OpenAPI, Swagger, JSDoc, comments, API docs, tutorials, user guides, doc site

metadata.role

specialist

metadata.scope

implementation

metadata.output-format

code

metadata.related-skills

spec-miner, fullstack-guardian, code-reviewer

def fetch_user(user_id: int, active_only: bool = True) -> dict:
    """Fetch a single user record by ID.

    Args:
        user_id: Unique identifier for the user.
        active_only: When True, raise an error for inactive users.

    Returns:
        A dict containing user fields (id, name, email, created_at).

    Raises:
        ValueError: If user_id is not a positive integer.
        UserNotFoundError: If no matching user exists.
    """

def compute_similarity(vec_a: np.ndarray, vec_b: np.ndarray) -> float:
    """Compute cosine similarity between two vectors.

    Parameters
    ----------
    vec_a : np.ndarray
        First input vector, shape (n,).
    vec_b : np.ndarray
        Second input vector, shape (n,).

    Returns
    -------
    float
        Cosine similarity in the range [-1, 1].

    Raises
    ------
    ValueError
        If vectors have different lengths.
    """

/**
 * Fetches a paginated list of products from the catalog.
 *
 * @param {string} categoryId - The category to filter by.
 * @param {number} [page=1] - Page number (1-indexed).
 * @param {number} [limit=20] - Maximum items per page.
 * @returns {Promise<ProductPage>} Resolves to a page of product records.
 * @throws {NotFoundError} If the category does not exist.
 *
 * @example
 * const page = await fetchProducts('electronics', 2, 10);
 * console.log(page.items);
 */
async function fetchProducts(
  categoryId: string,
  page = 1,
  limit = 20
): Promise<ProductPage> { ... }

© Jeffallan, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 8 other files (references) in skills/code-documenter of Jeffallan/claude-skills.

• SKILL.md
• references/api-docs-fastapi-django.md
• references/api-docs-nestjs-express.md
• references/coverage-reports.md
• references/documentation-systems.md
• references/interactive-api-docs.md
• references/python-docstrings.md
• references/typescript-jsdoc.md
• references/user-guides-tutorials.md

Open the folder on GitHubat commit 1be15d8