common-doc-generator
Generates documentation templates based on source code or skill files.
Install
mkdir -p .claude/skills/common-doc-generator && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/14946" && unzip -o skill.zip -d .claude/skills/common-doc-generator && rm skill.zipInstalls to .claude/skills/common-doc-generator
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Generate a structured 7-section common doc for any subsystem or .github/ component by tracing source code or skill files. Fills Purpose, Source of Truth, Request/Data Flow, Key Constraints, Verification, Common Failure Modes, and Related Files. Marks [NEEDS CONTENT] where evidence is insufficient. Chat output only — does not write files.Key capabilities
- →Generate a structured 7-section common doc for subsystems
- →Trace source code or skill files to gather evidence
- →Fill sections like Purpose, Source of Truth, and Data Flow
- →Mark sections with `[NEEDS CONTENT]` when evidence is insufficient
- →Cross-reference architecture claims against `.runtime-fidelity.json` or `.scan-report.md`
- →Output the completed doc as a markdown code block
How it works
The skill traces source code or skill files to gather evidence and populate a 7-section common document template, marking gaps where evidence is insufficient.
Inputs & outputs
When to use common-doc-generator
- →Document a subsystem
- →Create tech documentation
- →Understand component structure
About common-doc-generator
Creates a structured doc including purpose, flow, constraints, and verification steps by tracing existing code or instruction files.
Generate a structured 7-section common doc for any subsystem or .github/ component by tracing source code or skill files. Fills Purpose, Source of Truth, Request/Data Flow, Key Constraints, Verification, Common Failure Modes, and Related Files. Marks [NEEDS CONTENT] where evidence is insufficient. C
When not to use it
- →When finding what needs documenting
- →When the subsystem already has a good doc with all 7 sections
- →When needing architecture diagrams
Limitations
- →Code-mode tracing is limited to statically readable call chains
- →Kit-mode cannot capture runtime agent behavior
- →Generated doc is a starting point and requires review
How it compares
This skill automatically generates a structured documentation template pre-filled with code evidence, unlike manually creating documentation from scratch.
Compared to similar skills
common-doc-generator side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| common-doc-generator (this skill) | 0 | 6mo | Review | Intermediate |
| korean-skill-creator | 8 | 1y | Review | Beginner |
| skill-forge | 11 | 1y | Review | Intermediate |
| svelte-expert | 11 | 1y | No flags | Intermediate |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by vndkubi
View all by vndkubi →You might also like
korean-skill-creator
clwmfksek
한글 기반 클로드 스킬 자동 생성 도구. 사용자가 "클로드 스킬을 만들어줘" 또는 "[요구사항] 스킬 만들어줘"라고 요청할 때 사용. Progressive disclosure 원칙을 따르는 한글 문서 구조(SKILL.md + references/)를 자동으로 생성하고, 실전 예시를 포함한 일관성 있는 스킬 템플릿을 제공.
skill-forge
WilliamSaysX
Automated skill creation workshop with intelligent source detection, smart path management, and end-to-end workflow automation. This skill should be used when users want to create a new skill or convert external resources (GitHub repositories, online documentation, or local directories) into a skill. Automatically fetches, organizes, and packages skills with proactive cleanup management.
svelte-expert
Raudbjorn
Expert Svelte/SvelteKit development assistant for building components, utilities, and applications. Use when creating Svelte components, SvelteKit applications, implementing reactive patterns, handling state management, working with stores, transitions, animations, or any Svelte/SvelteKit development task. Includes comprehensive documentation access, code validation with svelte-autofixer, and playground link generation.
build-free-types
paulirish
This skill should be used when the user asks to "set up types without a build step", "use vanilla JS with types", "configure erasable syntax", or mentions "JSDoc type checking". It provides instructions for modern type safety using JSDoc in browsers and native TypeScript execution in Node.js.
vscode-ext-commands
github
Guidelines for contributing commands in VS Code extensions. Indicates naming convention, visibility, localization and other relevant attributes, following VS Code extension development guidelines, libraries and good practices
project-bootstrapper
mhattingpete
Sets up new projects or improves existing projects with development best practices, tooling, documentation, and workflow automation. Use when user wants to start a new project, improve project structure, add development tooling, or establish professional workflows.