Agent skill

Document Code

by codeaholicguy in codeaholicguy/ai-devkit

AI DevKit · Document a code entry point with structured analysis, dependency mapping, and saved knowledge docs.

Apache-2.0Auto-check passedFrontend & Design

Install Document Code

skills CLI
$ npx skills add codeaholicguy/ai-devkit --skill document-code -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install codeaholicguy/ai-devkit document-code --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/codeaholicguy/ai-devkit.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/document-code .claude/skills/document-code && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
document-code
GitHub stars
1.6k
Token cost
~1k tokens
SKILL.md length
487 words
Files
2
Skills in repo
28
Repo updated
First seen
Licence
Apache-2.0

At a glance

AI DevKit · Document a code entry point with structured analysis, dependency mapping, and saved knowledge docs.

  • Users ask to document
  • SKILL.md covers Hard Rule, Workflow, HTML Artifact and Red Flags and Rationalizations, plus 2 more sections
  • Calls npx; reaches cdn.jsdelivr.net
  • Map code for a module

What it does

Document Code is an agent skill from codeaholicguy/ai-devkit. AI DevKit · Document a code entry point with structured analysis, dependency mapping, and saved knowledge docs. Use when users ask to document, understand, or map code for a module, file, folder, function, or API.

Its SKILL.md is about 1k tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files (for example `agents/openai.yaml`).

It sits in Frontend & Design. The repository describes itself as: The control plane for AI coding agents. The licence is Apache-2.0.

When your agent uses it

  • Users ask to document
  • Map code for a module

Example prompts

  • “/document-code”

Requirements

  • Node.js

What it can do on your machine

Read from SKILL.md and the folder at commit 90dcca0. 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:

    • npx

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

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • cdn.jsdelivr.net

    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

Document Code loads about 1k tokens when it runs. Until then it costs about 57 tokens; SKILL.md has 487 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~57
When it runs · the whole SKILL.md, loaded when a task matches
~1k

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

Auto-check passed

The automated check found no risky patterns in SKILL.md.

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 codeaholicguy/ai-devkit at commit 90dcca0, republished under its Apache-2.0 licence (© codeaholicguy). 487 words, ~1,029 tokens.

Download SKILL.mdSave it as .claude/skills/document-code/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
document-code
description
AI DevKit · Document a code entry point with structured analysis, dependency mapping, and saved knowledge docs. Use when users ask to document, understand, or map code for a module, file, folder, function, or API.

Code Documentation Assistant

Build structured understanding of code entry points with an analysis-first workflow.

Hard Rule

  • Do not create documentation until the entry point is validated and analysis is complete.

Workflow

  1. Gather & Validate
  • Confirm entry point (file, folder, function, API), purpose, and desired depth.
  • Verify it exists; resolve ambiguity or suggest alternatives if not found.
  • Search for existing knowledge before analyzing: npx ai-devkit@latest memory search --query "<entry point name or purpose>"
  1. Collect Source Context
  • Summarize purpose, exports, key patterns.
  • Folders: list structure, highlight key modules.
  • Functions/APIs: capture signature, parameters, return values, error handling.
  1. Analyze Dependencies
  • Build dependency view up to depth 3, track visited nodes to avoid loops.
  • Categorize: imports, function calls, services, external packages.
  • Exclude external systems or generated code.
  1. Synthesize
  • Overview (purpose, language, high-level behavior).
  • Core logic, execution flow, patterns.
  • Error handling, performance, security considerations.
  • Improvements or risks discovered during analysis.
  1. Create Documentation
  • Normalize name to kebab-case (calculateTotalPrice → calculate-total-price).
  • Create docs/ai/implementation/knowledge-{name}.md using the Output Template — this is the source of truth.
  • Include mermaid diagrams when they clarify flows or relationships.
  1. Offer HTML Artifact
  • After the markdown is written, ask the user once: "Also generate an HTML artifact for easier scanning? (y/N)".
  • If yes, generate sibling docs/ai/implementation/knowledge-{name}.html per the HTML Artifact spec. Regenerate from the markdown on subsequent runs; never hand-edit.
  • If no or no response, stop here — markdown alone is a complete result.
Show full SKILL.md (256 more words)Show less

HTML Artifact

Generated only when the user opts in at step 6. A self-contained HTML file optimized for scanning, not reference reading. Complements the markdown — does not replace it.

Constraints:

  • Single file. Inline CSS. No build step. Only external asset allowed is mermaid via CDN (https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js).
  • Card-based grid layout, not a long scroll. The reader should capture structure at a glance.
  • Responsive down to laptop width. Print-friendly.
  • No interactivity beyond collapsible deep-dives and mermaid pan/zoom.

Section mapping (from the Output Template):

  • Overview → hero card: title, one-line purpose, language/type badges.
  • Implementation Details → grid of sectioned cards with short bullets, not prose.
  • Dependencies → graph card (mermaid) plus a categorized list (imports, calls, services, external).
  • Visual Diagrams → full-width rendered mermaid blocks.
  • Additional Insights → callout boxes, color-coded by kind (info, warning, risk).
  • Next Steps → checklist card.
  • Metadata → compact footer (date, depth, files touched).

Red Flags and Rationalizations

RationalizationWhy It's WrongDo Instead
"I already understand this code"Understanding ≠ documented understandingWrite it down, then verify
"The code is self-documenting"Future readers lack your current contextCapture the why, not just the what
"Dependencies are obvious"Implicit dependencies cause surprisesMap them explicitly to depth 3

Validation

  • Documentation covers all Output Template sections.
  • If an HTML artifact was generated, it opens standalone in a browser, renders mermaid, and reflects the markdown content (no drift).
  • Summarize key insights, open questions, and related areas for deeper dives.
  • Confirm file path(s) and remind to commit.

Output Template

  • Overview
  • Implementation Details
  • Dependencies
  • Visual Diagrams (mermaid)
  • Additional Insights
  • Metadata (date, depth, files touched)
  • Next Steps

© codeaholicguy, Apache-2.0. 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 1 other file in skills/document-code of codeaholicguy/ai-devkit.

  • SKILL.md
  • agents/openai.yaml

Open the folder on GitHubat commit 90dcca0

Compare with similar skills

Document Code next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Document Code compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Document Code this skillcodeaholicguy/ai-devkit1.6k—~1kAutomated safety check: PassApache-2.0
Web Artifacts Builderanthropics/skills180k41 repos~769Automated safety check: PassApache-2.0
React Doctormakeplane/plane61k12 repos~657Automated safety check: PassAGPL-3.0
Impeccablebestofjs/bestofjs3.1k27 repos~2.6kAutomated safety check: PassMIT
Figma Design System Builderwarpdotdev/warp65k2 repos~4.4kAutomated safety check: PassAGPL-3.0
Web Interface Guidelines Reviewervercel-labs/openreview1.7k97 repos~308Automated safety check: PassNone

Similar skills

  • Web Artifacts Builder

    anthropics/skills

    Official

    Builds multi-component claude.ai HTML artifacts as a small React, TypeScript and Tailwind project, then bundles it into one shareable HTML file.

    180k GitHub starsUsed in 41 repos~769 tokens
    Frontend & DesignAuto-check passed
  • React Doctor

    makeplane/plane

    Scans React code for lint, accessibility, bundle size and architecture issues, reports a health score and checks that changes do not lower it.

    61k GitHub starsUsed in 12 repos~657 tokens
    Frontend & DesignAuto-check passed
  • Impeccable

    bestofjs/bestofjs

    A skill your agent uses when the user wants to design, redesign, shape, critique, audit, polish, clarify, distill, harden, optimize, adapt, animate, colorize, extract, or otherwise improve a…

    3.1k GitHub starsUsed in 27 repos~2.6k tokens
    Frontend & DesignAuto-check passed
  • Builds or updates a design system in Figma from a codebase in ordered phases: discovery, variables and tokens, components, theming and documentation, with checkpoints.

    65k GitHub starsUsed in 2 repos~4.4k tokens
    Frontend & DesignAuto-check passed
  • Web Interface Guidelines Reviewer

    vercel-labs/openreview

    Official

    Review UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "check accessibility", "audit design", "review UX", or "check my…

    1.7k GitHub starsUsed in 97 repos~308 tokens
    Frontend & DesignAuto-check passed
  • Tailwindcss Development

    anonaddy/anonaddy

    Always invoke when the user's message includes 'tailwind' in any form.

    4.9k GitHub starsUsed in 10 repos~865 tokens
    Frontend & DesignAuto-check passed

More from codeaholicguy/ai-devkit

All 28 skills in this repo
  • Agent Management

    codeaholicguy/ai-devkit

    AI DevKit · Manage running AI agents with ai-devkit agent commands.

    1.6k GitHub stars~558 tokensUpdated today
    Auto-check passed
  • Dev Lifecycle

    codeaholicguy/ai-devkit

    AI DevKit · Orchestrator for structured SDLC phase skills. An agent skill from codeaholicguy/ai-devkit.

    1.6k GitHub stars~1.7k tokensUpdated today
    Auto-check passed
  • Task

    codeaholicguy/ai-devkit

    AI DevKit · Track dev-lifecycle / structured-debug progress on a durable task with the ai-devkit task CLI.

    1.6k GitHub stars~1.9k tokensUpdated today
    Auto-check passed
  • Simplify Implementation

    codeaholicguy/ai-devkit

    AI DevKit · Analyze and simplify existing implementations to reduce complexity, improve maintainability, and enhance scalability.

    1.6k GitHub stars~1.2k tokensUpdated today
    Auto-check passed
  • Agent Communication

    codeaholicguy/ai-devkit

    AI DevKit · Exchange information with active Codex, Claude Code, and other AI agents using ai-devkit agent list, detail, and send.

    1.6k GitHub stars~321 tokensUpdated today
    Auto-check passed
  • Technical Writer

    codeaholicguy/ai-devkit

    AI DevKit · Review and improve documentation for novice users.

    1.6k GitHub stars~431 tokensUpdated today
    Auto-check passed

Questions about Document Code

What does Document Code do?

AI DevKit · Document a code entry point with structured analysis, dependency mapping, and saved knowledge docs. Document Code is an agent skill from codeaholicguy/ai-devkit. AI DevKit · Document a code entry point with structured analysis, dependency mapping, and saved knowledge docs.

When should I use Document Code?

Document Code fits situations like: users ask to document; map code for a module.

How do I install Document Code in Claude Code?

Run `npx skills add codeaholicguy/ai-devkit --skill document-code -a claude-code`. Or copy the skill folder (skills/document-code in codeaholicguy/ai-devkit) into .claude/skills/document-code in your project. Claude Code loads it when a task matches its description.

How do I install Document Code in Codex?

Run `npx skills add codeaholicguy/ai-devkit --skill document-code -a codex`. Or copy the skill folder (skills/document-code in codeaholicguy/ai-devkit) into .agents/skills/document-code in your project. Codex loads it when a task matches its description.

Can I use Document Code in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add codeaholicguy/ai-devkit --skill document-code -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/document-code, .gemini/skills/document-code, .github/skills/document-code and .opencode/skills/document-code in your project.

What does Document Code need to run?

Going by SKILL.md and its folder, Document Code needs the command-line tools its instructions call (npx). Our summary lists: Node.js.

Does Document Code access the network?

SKILL.md names 1 domain. In commands or code: cdn.jsdelivr.net; the agent is likely to contact it when it follows the instructions. This is read from the text; nothing was executed.

Is Document Code safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Document Code use?

Document Code is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Document Code use?

About 1k tokens (SKILL.md is roughly 4.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Document Code?

Skills that share tags, products or a category with Document Code: Web Artifacts Builder (anthropics/skills, 180k stars), React Doctor (makeplane/plane, 61k stars), Impeccable (bestofjs/bestofjs, 3.1k stars) and Figma Design System Builder (warpdotdev/warp, 65k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Document Code?

codeaholicguy (a GitHub user) maintains it in codeaholicguy/ai-devkit, which has 1,643 GitHub stars. The repository holds 28 skills in this directory. The repository was last updated on October 9, 2026.

Source: codeaholicguy/ai-devkit on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.