Schematic
blader/schematic
Reverse engineer a detailed product and technical specification document from a git branch's implementation.
判断某项变更需要哪些 PRD、ADR、UI 规范（UI Spec）、设计文档（Design Doc）和工作计划，以及每种文档的存放位置。用于决定文档范围，或创建/评审技术文档时使用。
Install Documentation Criteria
$ npx skills add shinpr/ai-coding-project-boilerplate --skill documentation-criteria -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install shinpr/ai-coding-project-boilerplate documentation-criteria --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/shinpr/ai-coding-project-boilerplate.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills-zh-CN/documentation-criteria .claude/skills/documentation-criteria && 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 "documentation-criteria" agent skill from https://github.com/shinpr/ai-coding-project-boilerplate/tree/main/.claude/skills-zh-CN/documentation-criteria into .claude/skills/documentation-criteria/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-criteria", 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/shinpr/ai-coding-project-boilerplate/tree/main/.claude/skills-zh-CN/documentation-criteriaType 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 shinpr/ai-coding-project-boilerplate --skill documentation-criteria -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install shinpr/ai-coding-project-boilerplate documentation-criteria --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/shinpr/ai-coding-project-boilerplate.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.claude/skills-zh-CN/documentation-criteria .agents/skills/documentation-criteria && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "documentation-criteria" agent skill from https://github.com/shinpr/ai-coding-project-boilerplate/tree/main/.claude/skills-zh-CN/documentation-criteria into .agents/skills/documentation-criteria/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-criteria", 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 shinpr/ai-coding-project-boilerplate --skill documentation-criteria -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install shinpr/ai-coding-project-boilerplate documentation-criteria --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/shinpr/ai-coding-project-boilerplate.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.claude/skills-zh-CN/documentation-criteria .cursor/skills/documentation-criteria && 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 "documentation-criteria" agent skill from https://github.com/shinpr/ai-coding-project-boilerplate/tree/main/.claude/skills-zh-CN/documentation-criteria into .cursor/skills/documentation-criteria/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-criteria", 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/shinpr/ai-coding-project-boilerplate.git --path .claude/skills-zh-CN/documentation-criteria--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 shinpr/ai-coding-project-boilerplate --skill documentation-criteria -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install shinpr/ai-coding-project-boilerplate documentation-criteria --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/shinpr/ai-coding-project-boilerplate.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.claude/skills-zh-CN/documentation-criteria .gemini/skills/documentation-criteria && 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 "documentation-criteria" agent skill from https://github.com/shinpr/ai-coding-project-boilerplate/tree/main/.claude/skills-zh-CN/documentation-criteria into .gemini/skills/documentation-criteria/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-criteria", 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 shinpr/ai-coding-project-boilerplate documentation-criteriaInstalls 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 shinpr/ai-coding-project-boilerplate --skill documentation-criteria -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/shinpr/ai-coding-project-boilerplate.git skills-src && mkdir -p .github/skills && cp -r skills-src/.claude/skills-zh-CN/documentation-criteria .github/skills/documentation-criteria && 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 "documentation-criteria" agent skill from https://github.com/shinpr/ai-coding-project-boilerplate/tree/main/.claude/skills-zh-CN/documentation-criteria into .github/skills/documentation-criteria/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-criteria", 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 shinpr/ai-coding-project-boilerplate --skill documentation-criteria -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install shinpr/ai-coding-project-boilerplate documentation-criteria --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/shinpr/ai-coding-project-boilerplate.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.claude/skills-zh-CN/documentation-criteria .opencode/skills/documentation-criteria && 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 "documentation-criteria" agent skill from https://github.com/shinpr/ai-coding-project-boilerplate/tree/main/.claude/skills-zh-CN/documentation-criteria into .opencode/skills/documentation-criteria/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-criteria", 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
documentation-criteria- GitHub stars
- 234
- Token cost
- ~752 tokens
- SKILL.md length
- 128 words
- Files
- 7 (incl. references)
- Skills in repo
- 41
- Repo updated
- First seen
- Licence
- MIT
At a glance
判断某项变更需要哪些 PRD、ADR、UI 规范（UI Spec）、设计文档（Design Doc）和工作计划，以及每种文档的存放位置。用于决定文档范围，或创建/评审技术文档时使用。
- Works in 2 steps: 选择必要性（Choice） —… → 长期影响（Durability） —…
- Tasks that involve Architecture decision records
- SKILL.md covers 每种文档固定的内容, 创建决策矩阵, 结构规模 and ADR 决策过滤器, plus 2 more sections
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Documentation Criteria is an agent skill from shinpr/ai-coding-project-boilerplate. 判断某项变更需要哪些 PRD、ADR、UI 规范（UI Spec）、设计文档（Design Doc）和工作计划，以及每种文档的存放位置。用于决定文档范围，或创建/评审技术文档时使用。
Its SKILL.md is about 750 tokens, which your agent loads only when the skill is triggered. The skill folder holds 7 other files, including reference files (for example `references/adr-template.md`, `references/design-template.md` and `references/plan-template.md`).
It sits in Product & Project Management, covering Architecture decision records and PRD writing. The repository describes itself as: Agentic coding TypeScript boilerplate for Claude Code: sub-agent workflows with built-in quality checks and context engineering. The licence is MIT.
When your agent uses it
- Tasks that involve Architecture decision records
- Tasks that involve PRD writing
Example prompts
- “/documentation-criteria”
Workflow steps
2 steps, taken from the first numbered list in SKILL.md.
- 选择必要性（Choice） — 已确认的需求、已采纳的决策以及具有代表性的仓库依据，至少留下两个可信且实质性不同的备选方案。
- 长期影响（Durability） — 在这些方案中做出选择，会实质性地改变职责、依赖方向、共享契约、持久化方式、技术选型、可逆性，或未来工作必须维持或理解的生命周期成本。
What it can do on your machine
Read from SKILL.md and the folder at commit 56913a2. 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
No scripts in the folder and no shell commands in SKILL.md.
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
Documentation Criteria loads about 752 tokens when it runs, and up to ~11k if it reads all its reference files. Until then it costs about 29 tokens; SKILL.md has 128 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); files beside SKILL.md are not scanned.
SKILL.md
The full file from shinpr/ai-coding-project-boilerplate at commit 56913a2, republished under its MIT licence (© shinpr). 128 words, ~752 tokens.
Download SKILL.mdSave it as
.claude/skills/documentation-criteria/SKILL.md (or your agent's skills folder). This skill also uses 6 other files; get the full folder from GitHub.- name
- documentation-criteria
- description
- 判断某项变更需要哪些 PRD、ADR、UI 规范（UI Spec）、设计文档（Design Doc）和工作计划，以及每种文档的存放位置。用于决定文档范围，或创建/评审技术文档时使用。
文档创建标准
本技能负责文档路由：即变更需要记录哪些会对后续工作产生长期影响的决策，以及每种文档存放在何处。“存放位置”中链接的每个模板负责该文档的内容与结构要求。
每种文档固定的内容
- PRD — 固定业务成果、当前需求、排除项以及后续工作所追溯的验收标准。其 AC ID 是设计与验证的稳定追溯键。实现设计属于设计文档，技术方案选型属于 ADR，任务顺序属于工作计划
- ADR — 记录一项会对后续工作产生长期影响的技术选择，以及在决策中败选的实质性不同备选方案，使后续工作能够区分已接受的决策与偶发的实现细节。
Accepted记录的是当前选定的手段，而不是必须保留它的义务：当后续依据表明存在更小且足够的选择时，在已确认成果、目标状态需求和非目标保持成立的前提下，更新或取代该 ADR。完整的实现设计属于设计文档 - UI 规范 — 在实现之前记录界面结构、界面跳转、组件与状态契约、交互以及视觉验收标准。仅在这些决策尚未确定时创建；若具有代表性的仓库依据已经确定了这些内容，则复用已批准的 UI 规范，或直接进入设计文档
- 设计文档 — 记录已确认范围的完整实现设计：职责、流程、契约、变更影响以及验证边界。实现阶段将其视为主要技术基线，因此实现阶段不会擅自臆造缺失的“如何做”。当仓库依据推翻了技术上的“如何做”，而已确认的成果、目标状态需求和非目标仍然成立时，通过其所属工作流修正实现及受影响的技术产物，而无需重新打开产品需求
- 工作计划 — 固定依赖顺序、任务边界、可执行的验证方式以及最早可用的证明点。它引用设计细节，而非重复这些细节
- 任务文件 — 将一个可执行的工作计划成果、其约束来源、调查起点、写入职责以及可观测的验证方式带入实现阶段
创建决策矩阵
| 结构规模 | 基础文档 | 创建顺序 |
|---|---|---|
| Small（小型） | 无 | 直接实现 |
| Medium（中型） | 设计文档、工作计划 | 设计文档 -> 工作计划 |
| Large（大型） | PRD、设计文档、工作计划 | PRD -> 设计文档 -> 工作计划 |
对于前端/全栈工作，若相关决策尚未确定，应在设计文档之前新增 UI 规范。在设计文档之前完成任何符合条件的 ADR 批次。符合条件的 ADR 会将规模至少提升到中型。
对于 Large（大型）变更，可通过创建新 PRD、更新相关 PRD，或在没有现行产品文档时创建逆向工程 PRD 来满足 PRD 要求。无论规模如何，当产品范围发生变化时都应更新现有 PRD。
结构规模
按决策负担而非仓库层级来分类。文件数量仅作为辅助依据。
| 规模 | 决策负担 |
|---|---|
| Small（小型） | 单一连贯成果，在单一职责边界内有明显的、有仓库依据支持的实现方式，且不存在会对后续工作产生长期影响的未决选择 |
| Medium（中型） | 单一连贯成果，涉及跨边界协调或包含可能对后续工作产生长期影响的选择 |
| Large（大型） | 多个各自独立产生价值的成果，需要各自独立的设计决策 |
跨层实现如果服务于单一连贯成果，仍可归为 Medium（中型）。
ADR 决策过滤器
对已确认实现范围内的每个技术主题，依次应用“选择必要性（Choice）”和“长期影响（Durability）”这两个过滤条件。创建新记录前先检查已接受的 ADR。
- 选择必要性（Choice） — 已确认的需求、已采纳的决策以及具有代表性的仓库依据，至少留下两个可信且实质性不同的备选方案。
- 长期影响（Durability） — 在这些方案中做出选择，会实质性地改变职责、依赖方向、共享契约、持久化方式、技术选型、可逆性，或未来工作必须维持或理解的生命周期成本。
对通过这两个过滤器的每个主题创建一份 ADR，并将整个批次一并评审。将必须一起选择或一起重新考虑的选择归为一组；将可独立重新审视的决策分开。局部实现细节及其他成本低廉、易于逆转的选择属于设计文档。
存放位置
| 文档 | 路径 | 命名约定 | 模板 |
|---|---|---|---|
| PRD | docs/prd/ | [feature-name]-prd.md | prd-template.md |
| ADR | docs/adr/ | ADR-[4-digits]-[title].md | adr-template.md |
| UI 规范 | docs/ui-spec/ | [feature-name]-ui-spec.md | ui-spec-template.md |
| UI 规范附件 | docs/ui-spec/assets/{feature-name}/ | 原型代码文件 | - |
| 设计文档 | docs/design/ | [feature-name]-design.md | design-template.md |
| 工作计划 | docs/plans/ | YYYYMMDD-{type}-{description}.md | plan-template.md |
| 任务文件 | docs/plans/tasks/ | {plan-name}-task-{NN}.md（仅含 backend 的计划）；{plan-name}-backend-task-{NN}.md（混合层计划中的 backend）；{plan-name}-frontend-task-{NN}.md（frontend） | task-template.md |
生成路径中的变量必须使用小写 ASCII kebab-case slug。非 ASCII 输入应在构造路径前转换为该格式。
工作计划已在 .gitignore 中排除。
参考资料
每个模板定义了其文档的内容、状态规则、所需依据、可选图表以及完成检查项。仅加载正在创建或评审的文档所对应的模板。
© shinpr, 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 6 other files (references) in .claude/skills-zh-CN/documentation-criteria of shinpr/ai-coding-project-boilerplate.
- SKILL.md
- references/adr-template.md
- references/design-template.md
- references/plan-template.md
- references/prd-template.md
- references/task-template.md
- references/ui-spec-template.md
Open the folder on GitHubat commit 56913a2
Compare with similar skills
Documentation Criteria 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 |
|---|---|---|---|---|---|---|
| Documentation Criteria this skillshinpr/ai-coding-project-boilerplate | 234 | — | ~752 | Automated safety check: Pass | MIT | |
| Schematicblader/schematic | 241 | — | ~2.2k | Automated safety check: Pass | MIT | |
| Shep Workstreamsshep-ai/shep | 264 | — | ~2.5k | Automated safety check: Pass | MIT | |
| Write Update Tidb Docspingcap/docs | 616 | — | ~2.3k | Automated safety check: Pass | Custom licence | |
| Rfc Modelingmirumee/nimara-ecommerce | 129 | — | ~920 | Automated safety check: Pass | BSD-3-Clause | |
| Req Change Workflowyunshu0909/yunshu_skillshub | 768 | — | ~1.4k | Automated safety check: Pass | MIT |
Similar skills
Shep Workstreams
shep-ai/shep
A skill your agent uses when a large body of work (a version milestone, an epic, a roadmap, a set of PRDs/design docs) needs to be broken into parallel workstreams and executed with the shep CLI.
Write Update Tidb Docs
pingcap/docs
Write new TiDB documentation or update existing TiDB documentation from code changes, PRs, issues, design docs, product specs, rough drafts, existing docs, or short feature descriptions.
Rfc Modeling
mirumee/nimara-ecommerce
A skill your agent uses when designing, drafting, refining, or stress-testing an RFC for an approved PRD, including requests for a design doc, solution design, or how to build it.
Req Change Workflow
yunshu0909/yunshu_skillshub
已有功能的需求变更闭环（门禁式七步）。触发硬条件：要改的功能已经实现并跑起来了。当用户说"改需求""需求变更""调整交互""改功能""重构流程"，或改动容易散到多个文件、碰到鉴权/存储/配置/权限、需要可靠验证 + 回滚方案时使用。流程：锁 scope 写 change brief → 从代码确认当前行为（不靠记忆和假设）→ 影响面与风险评估 + 回滚计划 →…
Gsd Ingest Docs
open-gsd/gsd-core
Bootstrap or merge a .planning/ setup from existing ADRs, PRDs, SPECs, and docs in a repo.
More from shinpr/ai-coding-project-boilerplate
All 41 skills in this repoIntegration E2E Testing
shinpr/ai-coding-project-boilerplate
Selects and designs the smallest integration/E2E test set that proves accepted behavior at an observable boundary.
Skill Optimization
shinpr/ai-coding-project-boilerplate
Evaluates and optimizes skill file quality using 9 content patterns and 10 editing principles.
Frontend Technical Spec
shinpr/ai-coding-project-boilerplate
Defines React environment, component architecture, state/data flow, build verification, and frontend non-functional criteria from repository evidence.
Frontend Typescript Rules
shinpr/ai-coding-project-boilerplate
Applies React/TypeScript type safety, component design, and state management rules.
Implementation Approach
shinpr/ai-coding-project-boilerplate
Selects implementation strategy (vertical slice, horizontal, or hybrid) with risk assessment.
Subagents Orchestration Guide
shinpr/ai-coding-project-boilerplate
Coordinates subagents through scale-based planning, approval, implementation, verification, and escalation flows.
Related
Categories
Questions about Documentation Criteria
What does Documentation Criteria do?
判断某项变更需要哪些 PRD、ADR、UI 规范（UI Spec）、设计文档（Design Doc）和工作计划，以及每种文档的存放位置。用于决定文档范围，或创建/评审技术文档时使用。. Documentation Criteria is an agent skill from shinpr/ai-coding-project-boilerplate.
When should I use Documentation Criteria?
Documentation Criteria fits situations like: tasks that involve Architecture decision records; tasks that involve PRD writing.
How do I install Documentation Criteria in Claude Code?
Run `npx skills add shinpr/ai-coding-project-boilerplate --skill documentation-criteria -a claude-code`. Or copy the skill folder (.claude/skills-zh-CN/documentation-criteria in shinpr/ai-coding-project-boilerplate) into .claude/skills/documentation-criteria in your project. Claude Code loads it when a task matches its description.
How do I install Documentation Criteria in Codex?
Run `npx skills add shinpr/ai-coding-project-boilerplate --skill documentation-criteria -a codex`. Or copy the skill folder (.claude/skills-zh-CN/documentation-criteria in shinpr/ai-coding-project-boilerplate) into .agents/skills/documentation-criteria in your project. Codex loads it when a task matches its description.
Can I use Documentation Criteria 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 shinpr/ai-coding-project-boilerplate --skill documentation-criteria -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documentation-criteria, .gemini/skills/documentation-criteria, .github/skills/documentation-criteria and .opencode/skills/documentation-criteria in your project.
What does Documentation Criteria need to run?
SKILL.md names no scripts, command-line tools or credentials: Documentation Criteria is instructions for the agent only.
Does Documentation Criteria 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 Documentation Criteria 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 Documentation Criteria use?
Documentation Criteria is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Documentation Criteria use?
About 752 tokens (SKILL.md is roughly 3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 9.9k tokens, read only when the agent opens those files.
What are the alternatives to Documentation Criteria?
Skills that share tags, products or a category with Documentation Criteria: Schematic (blader/schematic, 241 stars), Shep Workstreams (shep-ai/shep, 264 stars), Write Update Tidb Docs (pingcap/docs, 616 stars) and Rfc Modeling (mirumee/nimara-ecommerce, 129 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Documentation Criteria?
shinpr (a GitHub user) maintains it in shinpr/ai-coding-project-boilerplate, which has 234 GitHub stars. The repository holds 41 skills in this directory. The repository was last updated on October 4, 2026.
Source: shinpr/ai-coding-project-boilerplate on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.