documentation-criteria SKILL.md skillA

documentation-criteria from shinpr/ai-coding-project-boilerplate is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

mdr add shinpr/ai-coding-project-boilerplate/documentation-criteria@git:20260923.86a3d79

Pins git:20260923.86a3d79 in mdr.lock. Pin the fingerprint instead.

Audit grade

A, 17 of 17 checks passed

Kind

SKILL.md skill

Repository

shinpr/ai-coding-project-boilerplate

Path

.claude/skills-zh-CN/documentation-criteria/SKILL.md

Versions recorded

5

Latest version

git:20260923.86a3d79, committed Sep 23, 2026

First version recorded

Aug 31, 2026

Size

6,141 bytes

Repository stars

234

License

MIT

判断某项变更需要哪些 PRD、ADR、UI 规范（UI Spec）、设计文档（Design Doc）和工作计划，以及每种文档的存放位置。用于决定文档范围，或创建/评审技术文档时使用。.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# 文档创建标准

本技能负责文档路由：即变更需要记录哪些会对后续工作产生长期影响的决策，以及每种文档存放在何处。“存放位置”中链接的每个模板负责该文档的内容与结构要求。

## 每种文档固定的内容

- **PRD** — 固定业务成果、当前需求、排除项以及后续工作所追溯的验收标准。其 AC ID 是设计与验证的稳定追溯键。实现设计属于设计文档，技术方案选型属于 ADR，任务顺序属于工作计划
- **ADR** — 记录一项会对后续工作产生长期影响的技术选择，以及在决策中败选的实质性不同备选方案，使后续工作能够区分已接受的决策与偶发的实现细节。`Accepted` 记录的是当前选定的手段，而不是必须保留它的义务：当后续依据表明存在更小且足够的选择时，在已确认成果、目标状态需求和非目标保持成立的前提下，更新或取代该 ADR。完整的实现设计属于设计文档
- **UI 规范** — 在实现之前记录界面结构、界面跳转、组件与状态契约、交互以及视觉验收标准。仅在这些决策尚未确定时创建；若具有代表性的仓库依据已经确定了这些内容，则复用已批准的 UI 规范，或直接进入设计文档
- **设计文档** — 记录已确认范围的完整实现设计：职责、流程、契约、变更影响以及验证边界。实现阶段将其视为主要技术基线，因此实现阶段不会擅自臆造缺失的“如何做”。当仓库依据推翻了技术上的“如何做”，而已确认的成果、目标状态需求和非目标仍然成立时，通过其所属工作流修正实现及受影响的技术产物，而无需重新打开产品需求
- **工作计划** — 固定依赖顺序、任务边界、可执行的验证方式以及最早可用的证明点。它引用设计细节，而非重复这些细节
- **任务文件** — 将一个可执行的工作计划成果、其约束来源、调查起点、写入职责以及可观测的验证方式带入实现阶段

## 创建决策矩阵

| 结构规模 | 基础文档 | 创建顺序 |
|------------------|----------------|----------------|
| Small（小型） | 无 | 直接实现 |
| Medium（中型） | 设计文档、工作计划 | 设计文档 -> 工作计划 |
| Large（大型） | PRD、设计文档、工作计划 | PRD -> 设计文档 -> 工作计划 |

对于前端/全栈工作，若相关决策尚未确定，应在设计文档之前新增 UI 规范。在设计文档之前完成任何符合条件的 ADR 批次。符合条件的 ADR 会将规模至少提升到中型。

对于 Large（大型）变更，可通过创建新 PRD、更新相关 PRD，或在没有现行产品文档时创建逆向工程 PRD 来满足 PRD 要求。无论规模如何，当产品范围发生变化时都应更新现有 PRD。

## 结构规模

按决策负担而非仓库层级来分类。文件数量仅作为辅助依据。
…

Read the whole file at its exact version.

How to install

mdr add shinpr/ai-coding-project-boilerplate/documentation-criteria@sha256:7dc70c4a597da446

[![mdr](https://markdownregistry.com/badge/art_74sf7cyyfhkancga.svg)](https://markdownregistry.com/a/art_74sf7cyyfhkancga)

Versions

The registry has recorded 5 versions of this file, between Aug 31, 2026 and Sep 23, 2026, about one every 6 days.

Audit of the latest version

Source

API

GET https://markdownregistry.com/api/v1/artifacts/art_74sf7cyyfhkancga
GET https://markdownregistry.com/api/v1/resolve?ref=shinpr/ai-coding-project-boilerplate/documentation-criteria
GET https://markdownregistry.com/api/v1/blob/7dc70c4a597da4460355633b9b146a548462f641adfc05a62e31b626feaa554a

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from shinpr/ai-coding-project-boilerplate

Every file in shinpr/ai-coding-project-boilerplate

Other files named documentation-criteria

Browse by kind, by grade A, or by owner.