Diagram Design
cathrynlavery/diagram-design
Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.
Generates/updates README, API docs, architecture notes. An agent skill from softspark/ai-toolkit.
Install Docs
$ npx skills add softspark/ai-toolkit --skill docs -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install softspark/ai-toolkit docs --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/softspark/ai-toolkit.git skills-src && mkdir -p .claude/skills && cp -r skills-src/app/skills/docs .claude/skills/docs && rm -rf skills-srcUse ~/.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/
Install the "docs" agent skill from https://github.com/softspark/ai-toolkit/tree/main/app/skills/docs into .claude/skills/docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/softspark/ai-toolkit/tree/main/app/skills/docsType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add softspark/ai-toolkit --skill docs -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install softspark/ai-toolkit docs --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/softspark/ai-toolkit.git skills-src && mkdir -p .agents/skills && cp -r skills-src/app/skills/docs .agents/skills/docs && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "docs" agent skill from https://github.com/softspark/ai-toolkit/tree/main/app/skills/docs into .agents/skills/docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add softspark/ai-toolkit --skill docs -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install softspark/ai-toolkit docs --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/softspark/ai-toolkit.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/app/skills/docs .cursor/skills/docs && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "docs" agent skill from https://github.com/softspark/ai-toolkit/tree/main/app/skills/docs into .cursor/skills/docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/softspark/ai-toolkit.git --path app/skills/docs--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add softspark/ai-toolkit --skill docs -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install softspark/ai-toolkit docs --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/softspark/ai-toolkit.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/app/skills/docs .gemini/skills/docs && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "docs" agent skill from https://github.com/softspark/ai-toolkit/tree/main/app/skills/docs into .gemini/skills/docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install softspark/ai-toolkit docsInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add softspark/ai-toolkit --skill docs -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/softspark/ai-toolkit.git skills-src && mkdir -p .github/skills && cp -r skills-src/app/skills/docs .github/skills/docs && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "docs" agent skill from https://github.com/softspark/ai-toolkit/tree/main/app/skills/docs into .github/skills/docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add softspark/ai-toolkit --skill docs -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install softspark/ai-toolkit docs --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/softspark/ai-toolkit.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/app/skills/docs .opencode/skills/docs && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "docs" agent skill from https://github.com/softspark/ai-toolkit/tree/main/app/skills/docs into .opencode/skills/docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
docs- GitHub stars
- 179
- Token cost
- ~1.1k tokens
- SKILL.md length
- 303 words
- Files
- 4 (incl. scripts)
- Skills in repo
- 112
- Repo updated
- First seen
- Licence
- Apache-2.0
At a glance
Generates/updates README, API docs, architecture notes. An agent skill from softspark/ai-toolkit.
- Works in 4 steps: Analyzes code structure → Extracts documentation info → Generates documentation files → …
- Tasks that involve Technical documentation
- SKILL.md covers Usage, What This Command Does, Documentation Types and KB Document Rules (MANDATORY), plus 8 more sections
- Runs Python scripts from its folder; calls python3
What it does
Docs is an agent skill from softspark/ai-toolkit. Generates/updates README, API docs, architecture notes. Triggers: docs, README, API docs, architecture note, documentation.
Its SKILL.md is about 1.1k tokens, which your agent loads only when the skill is triggered. The skill folder holds 5 other files, including scripts (for example `scripts/doc-inventory.py`, `templates/adr-template.md` and `templates/readme-template.md`).
It sits in Development, covering Technical documentation. The repository describes itself as: Professional-grade AI coding toolkit: 94 skills, 44 agents, multi-platform (Claude, Cursor, Windsurf, Copilot, Gemini, Cline, Roo Code, Aider, Augment, Antigravity, Codex CLI… The licence is Apache-2.0.
When your agent uses it
- Tasks that involve Technical documentation
Example prompts
- “/docs”
Requirements
- Python 3
- Pre-approved tools (allowed-tools): Read, Write, Grep, Glob
Workflow steps
4 steps, taken from the first numbered list in SKILL.md.
- Analyzes code structure
- Extracts documentation info
- Generates documentation files
- Updates existing docs
What it can do on your machine
Read from SKILL.md and the folder at commit d64db2b. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves these tools, so the agent can use them without asking each time:
ReadWriteGrepGlob
From allowed-tools in the SKILL.md frontmatter.
Runs code
Ships 1 file in scripts/ (Python), which the agent can run.
Shell commands in SKILL.md call:
python3
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
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
Docs loads about 1.1k tokens when it runs. Until then it costs about 32 tokens; SKILL.md has 303 words of instructions outside code blocks.
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); the scripts in this folder are not scanned.
SKILL.md
The full file from softspark/ai-toolkit at commit d64db2b, republished under its Apache-2.0 licence (© softspark). 303 words, ~1,050 tokens.
Download SKILL.mdSave it as
.claude/skills/docs/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.- name
- docs
- description
- Generates/updates README, API docs, architecture notes. Triggers: docs, README, API docs, architecture note, documentation.
- allowed-tools
- Read, Write, Grep, Glob
- user-invocable
- true
- effort
- high
- argument-hint
- [type: readme/api/architecture-note]
- agent
- documenter
- context
- fork
Generate Documentation
$ARGUMENTS
Generate or update documentation.
Usage
/docs [type] [target]What This Command Does
- Analyzes code structure
- Extracts documentation info
- Generates documentation files
- Updates existing docs
Documentation Types
| Type | Description |
|---|---|
readme | Generate/update README |
api | API documentation |
architecture-note | Architecture note |
changelog | Generate changelog |
comments | Add code comments |
kb | Knowledge base entry (enforces KB structure) |
KB Document Rules (MANDATORY)
When creating or updating documents in the kb/ directory, follow the documentation-standards knowledge skill (auto-loaded). Key rules:
- 7 required frontmatter fields: title, category, service, tags, created, last_updated, description
- 6 valid categories: reference, howto, procedures, troubleshooting, best-practices, planning
- Category must match directory (e.g.,
category: howto→kb/howto/) - English only. No exceptions.
- validate.sh rejects docs without valid frontmatter.
Full spec: see app/skills/documentation-standards/SKILL.md.
Templates
README Generation
# [Project Name]
[Auto-generated description]
## Installation
[Detected from package manager]
## Usage
[Extracted from code/examples]
## API
[Extracted from code]
## License
[Detected]Architecture Note Template
# Architecture Note: [TITLE]
## Status
Proposed
## Context
[What is the issue?]
## Decision
[What was decided?]
## Consequences
[What are the results?]
## Date
[Today's date]Output Format
## Documentation Report
### Generated
- [file 1]
- [file 2]
### Updated
- [file 3]: [what changed]
### Skipped
- [file 4]: [reason]
### Next Steps
- [ ] Review generated docs
- [ ] Add missing details
- [ ] Commit changesCommon Rationalizations
| Excuse | Why It's Wrong |
|---|---|
| "The code is self-documenting" | Code shows how, not why — decisions, constraints, and context need prose |
| "Nobody reads docs anyway" | People don't read bad docs — good docs are the first thing consulted |
| "I'll document it when it's stable" | Unstable code needs docs most — document intent so others can contribute |
| "Comments get stale" | That's an argument for maintaining docs, not skipping them |
| "The tests are the documentation" | Tests verify behavior but don't explain architecture, trade-offs, or setup |
Configuration
Documentation settings in:
.claude/settings.json- Project's doc config
REVIEW BEFORE COMMIT
Generated documentation should be reviewed. AI may miss context or make assumptions.
Documentation Inventory
Run the bundled script to audit documentation coverage and find gaps:
python3 ${CLAUDE_SKILL_DIR}/scripts/doc-inventory.py .Parallel Documentation (large codebases)
If the inventory script reports doc_coverage_percent < 50 and the project has multiple modules, use Agent Teams for parallel documentation:
Create an agent team for documentation:
- Teammate 1 (documenter): "Document the [module-1] directory. Generate docstrings for all public functions." Use Sonnet.
- Teammate 2 (documenter): "Document the [module-2] directory. Generate docstrings for all public functions." Use Sonnet.
- Teammate 3 (documenter): "Generate README sections: installation, usage, API reference." Use Opus.
Teammates should NOT overlap — each owns their assigned scope.Related Skills
- Documenting an architecture decision? →
/councilfor multi-perspective analysis first - Need to explore the codebase? →
/exploreto understand structure before documenting - Writing a PRD? →
/write-a-prdfor structured product requirements - Auditing existing docs? →
/analyzefor coverage gaps
© softspark, 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 3 other files (scripts) in app/skills/docs of softspark/ai-toolkit.
- SKILL.md
- scripts/doc-inventory.py
- templates/adr-template.md
- templates/readme-template.md
Open the folder on GitHubat commit d64db2b
Compare with similar skills
Docs 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.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Docs this skillsoftspark/ai-toolkit | 179 | — | ~1.1k | Automated safety check: Pass | Apache-2.0 | |
| Diagram Designcathrynlavery/diagram-design | 44k | 1 repos | ~7.5k | Automated safety check: Pass | MIT | |
| Simple Englishmoeru-ai/airi | 50k | 2 repos | ~4.6k | Automated safety check: Pass | MIT | |
| Get API Docs with chubandrewyng/context-hub | 14k | 2 repos | ~775 | Automated safety check: Pass | MIT | |
| Doc SyncJetBrains/ideavim | 10k | 2 repos | ~2.6k | Automated safety check: Pass | MIT | |
| Mailspring App ScreenshotsFoundry376/Mailspring | 18k | — | ~1.4k | Automated safety check: Pass | GPL-3.0 |
Similar skills
Simple English
moeru-ai/airi
Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.
Get API Docs with chub
andrewyng/context-hub
Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.
- Official
Doc Sync
JetBrains/ideavim
Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.
Mailspring App Screenshots
Foundry376/Mailspring
Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.
Draw.io Diagram Studio
Agents365-ai/drawio-skill
Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.
More from softspark/ai-toolkit
All 112 skills in this repoPrepare Test Env
softspark/ai-toolkit
Prepare or verify a project QA environment with source identity, readiness, browser access, evidence paths and owned cleanup.
A11y Validate
softspark/ai-toolkit
Accessibility validator: WCAG 2.1 AA, EN 301 549, EAA. An agent skill from softspark/ai-toolkit.
Analyze
softspark/ai-toolkit
Analyzes code quality, complexity, patterns across codebase.
Autonomous Dev
softspark/ai-toolkit
Drives a brief, specification, issue or existing PR through implementation, review, tests and QA to a ready PR.
Brand Voice
softspark/ai-toolkit
Direct technical voice for docs, README, user-facing text. An agent skill from softspark/ai-toolkit.
CI
softspark/ai-toolkit
Detect/generate/debug CI pipeline config (GitHub Actions, GitLab CI).
Related
Categories
Questions about Docs
What does Docs do?
Generates/updates README, API docs, architecture notes. An agent skill from softspark/ai-toolkit. Docs is an agent skill from softspark/ai-toolkit. Generates/updates README, API docs, architecture notes.
When should I use Docs?
Docs fits situations like: tasks that involve Technical documentation.
How do I install Docs in Claude Code?
Run `npx skills add softspark/ai-toolkit --skill docs -a claude-code`. Or copy the skill folder (app/skills/docs in softspark/ai-toolkit) into .claude/skills/docs in your project. Claude Code loads it when a task matches its description.
How do I install Docs in Codex?
Run `npx skills add softspark/ai-toolkit --skill docs -a codex`. Or copy the skill folder (app/skills/docs in softspark/ai-toolkit) into .agents/skills/docs in your project. Codex loads it when a task matches its description.
Can I use Docs 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 softspark/ai-toolkit --skill docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs, .gemini/skills/docs, .github/skills/docs and .opencode/skills/docs in your project.
What does Docs need to run?
Going by SKILL.md and its folder, Docs needs Python for the scripts in its folder and the command-line tools its instructions call (python3). Our summary lists: Python 3. Its frontmatter pre-approves these tools: Read, Write, Grep, Glob.
Does Docs access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Docs 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. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.
What licence does Docs use?
Docs 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 Docs use?
About 1.1k tokens (SKILL.md is roughly 4.2k 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 Docs?
Skills that share tags, products or a category with Docs: Diagram Design (cathrynlavery/diagram-design, 44k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Docs?
softspark (a GitHub user) maintains it in softspark/ai-toolkit, which has 179 GitHub stars. The repository holds 112 skills in this directory. The repository was last updated on October 7, 2026.
Source: softspark/ai-toolkit on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.