documentation-criteria SKILL.md skillA

documentation-criteria from shinpr/codex-workflows is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add shinpr/codex-workflows/documentation-criteria@git:20261102.2a1d2f6

Pins git:20261102.2a1d2f6 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
shinpr/codex-workflows
Path
.agents/skills/documentation-criteria/SKILL.md
Versions recorded
9
Latest version
git:20261102.2a1d2f6, committed Nov 2, 2026
First version recorded
Aug 1, 2026
Size
6,639 bytes
Repository stars
38
License
MIT

Determines which PRD, ADR, UI Spec, Design Doc, and Work Plan a change requires and where each document lives. Use when deciding documentation scope or creating or reviewing one of these artifacts.

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

# Documentation Creation Criteria

## Templates

- **[prd-template.md](references/prd-template.md)** - Product Requirements Document template
- **[adr-template.md](references/adr-template.md)** - Architecture Decision Record template
- **[ui-spec-template.md](references/ui-spec-template.md)** - UI Specification template (frontend/fullstack features)
- **[design-template.md](references/design-template.md)** - Technical Design Document template
- **[plan-template.md](references/plan-template.md)** - Work Plan template

## Creation Decision Matrix [MANDATORY]

| Structural Scale | Base Documents | Creation Order |
|------------------|----------------|----------------|
| Small | None | N/A |
| Medium | Design Doc -> Work Plan | Start with Design Doc |
| Large | PRD* -> Design Doc -> Work Plan | Continue after product-scope approval |

Build one path in this order:

1. Select the base path from Structural Scale.
2. Frontend or fullstack scope inserts UI Spec immediately before the Design Doc.
3. One or more qualifying ADR decision points insert an ADR batch immediately before the Design Doc. A qualifying decision point sets the scale floor to Medium.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add shinpr/codex-workflows/documentation-criteria@sha256:b97bf26508b85aa5

The line at the top of this page pins the label git:20261102.2a1d2f6, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

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

3 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 9 versions of this file, between Aug 1, 2026 and Nov 2, 2026, about one every 12 days.

versioncommittedcommitsizeaudit
git:20261102.2a1d2f6 latest2026-11-02 2a1d2f6 6,639 BA view · diff
git:20261102.ce009f82026-11-02 ce009f8 6,669 BA view · diff
git:20260915.0c8f5172026-09-15 0c8f517 6,155 BA view · diff
git:20260915.3b2dc522026-09-15 3b2dc52 6,072 BA view · diff
git:20260815.ca3b5072026-08-15 ca3b507 5,860 BA view · diff
git:20260804.580f2952026-08-04 580f295 10,852 BA view · diff
git:20260802.c0182802026-08-02 c018280 9,562 BA view · diff
git:20260802.aa3bfed2026-08-02 aa3bfed 9,500 BA view · diff
git:20260801.00c4c632026-08-01 00c4c63 9,470 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (6639 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

shinpr/codex-workflows · 38 stars · license MIT · pushed 2026-11-03 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_sods2kddihoq26tp
GET https://markdownregistry.com/api/v1/resolve?ref=shinpr/codex-workflows/documentation-criteria
GET https://markdownregistry.com/api/v1/blob/b97bf26508b85aa575b155b997f81466e4ce08ba8f4f073e5417b77a5cddf4b8

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/codex-workflows

ai-development-guide SKILL.md skill
shinpr/codex-workflows · .agents/skills/ai-development-guide/SKILL.md · Root-cause discipline, proportionate impact analysis, and implementation completeness assurance. Use when fixing bugs…
git:20261102.2a1d2f6 · audit A · 38 stars
coding-rules SKILL.md skill
shinpr/codex-workflows · .agents/skills/coding-rules/SKILL.md · Repository-aware implementation rules for minimal design surface, contract safety, representative patterns, and…
git:20260922.5475540 · audit A · 38 stars
external-resource-context SKILL.md skill
shinpr/codex-workflows · .agents/skills/external-resource-context/SKILL.md · Resolves and records one external evidence source required by a current design or verification decision. Use when…
git:20260915.0c8f517 · audit A · 38 stars
implementation-approach SKILL.md skill
shinpr/codex-workflows · .agents/skills/implementation-approach/SKILL.md · Selects the smallest sufficient implementation strategy and verification boundary from current requirements and…
git:20261102.2a1d2f6 · audit A · 38 stars
integration-e2e-testing SKILL.md skill
shinpr/codex-workflows · .agents/skills/integration-e2e-testing/SKILL.md · Selects and specifies the integration/E2E tests that own accepted behavior at the boundary where it is observable.
git:20261102.2a1d2f6 · audit A · 38 stars
llm-friendly-context SKILL.md skill
shinpr/codex-workflows · .agents/skills/llm-friendly-context/SKILL.md · Clarifies inputs, outputs, success criteria, decisions, and unresolved conditions so downstream agents can execute…
git:20261022.e38db2d · audit A · 38 stars
recipe-add-integration-tests SKILL.md skill
shinpr/codex-workflows · .agents/skills/recipe-add-integration-tests/SKILL.md · Add integration/E2E tests to existing codebase using Design Docs.
git:20261023.aaf52b6 · audit A · 38 stars
recipe-build SKILL.md skill
shinpr/codex-workflows · .agents/skills/recipe-build/SKILL.md · Execute an approved backend Work Plan autonomously through task execution, quality fixes, commits, and final…
git:20261023.aaf52b6 · audit A · 38 stars
recipe-design SKILL.md skill
shinpr/codex-workflows · .agents/skills/recipe-design/SKILL.md · Execute from codebase-scoped analysis to design document creation.
git:20261102.2a1d2f6 · audit A · 38 stars
recipe-diagnose SKILL.md skill
shinpr/codex-workflows · .agents/skills/recipe-diagnose/SKILL.md · Investigate problem, verify findings, and derive solutions through structured diagnosis.
git:20261023.aaf52b6 · audit A · 38 stars
recipe-front-adjust SKILL.md skill
shinpr/codex-workflows · .agents/skills/recipe-front-adjust/SKILL.md · Adjust an implemented UI with focused evidence, verification, and quality checks.
git:20261023.aaf52b6 · audit A · 38 stars
recipe-front-build SKILL.md skill
shinpr/codex-workflows · .agents/skills/recipe-front-build/SKILL.md · Execute an approved frontend Work Plan autonomously through frontend implementation, quality fixes, commits, and final…
git:20261023.aaf52b6 · audit A · 38 stars

Every file in shinpr/codex-workflows

Other files named documentation-criteria

documentation-criteria SKILL.md skill
shinpr/claude-code-workflows · dev-workflows/skills/documentation-criteria/SKILL.md · Determines which of PRD, ADR, UI Spec, Design Doc, and Work Plan a change requires, and where each is stored. Use when…
git:20261029.3d4a3cd · audit A · 707 stars
documentation-criteria SKILL.md skill
shinpr/claude-code-workflows · dev-skills/skills/documentation-criteria/SKILL.md · Determines which of PRD, ADR, UI Spec, Design Doc, and Work Plan a change requires, and where each is stored. Use when…
git:20261029.3d4a3cd · audit A · 707 stars
documentation-criteria SKILL.md skill
shinpr/claude-code-workflows · dev-workflows-fullstack/skills/documentation-criteria/SKILL.md · Determines which of PRD, ADR, UI Spec, Design Doc, and Work Plan a change requires, and where each is stored. Use when…
git:20261029.3d4a3cd · audit A · 707 stars
documentation-criteria SKILL.md skill
shinpr/claude-code-workflows · dev-workflows-frontend/skills/documentation-criteria/SKILL.md · Determines which of PRD, ADR, UI Spec, Design Doc, and Work Plan a change requires, and where each is stored. Use when…
git:20261029.3d4a3cd · audit A · 707 stars
documentation-criteria SKILL.md skill
shinpr/claude-code-workflows · skills/documentation-criteria/SKILL.md · Determines which of PRD, ADR, UI Spec, Design Doc, and Work Plan a change requires, and where each is stored. Use when…
git:20261021.b8585b7 · audit A · 707 stars
documentation-criteria SKILL.md skill
shinpr/ai-coding-project-boilerplate · .claude/skills-ja/documentation-criteria/SKILL.md · 変更に必要なPRD、ADR、UI Spec、Design Doc、作業計画書と、それぞれの保存先を判定する。ドキュメントの範囲を決める時、または技術ドキュメントを作成・レビューする時に使用。
git:20261021.27b5dea · audit A · 236 stars
documentation-criteria SKILL.md skill
shinpr/ai-coding-project-boilerplate · .claude/skills-zh-CN/documentation-criteria/SKILL.md · 判断某项变更需要哪些 PRD、ADR、UI 规范(UI Spec)、设计文档(Design Doc)和工作计划,以及每种文档的存放位置。用于决定文档范围,或创建/评审技术文档时使用。
git:20261021.27b5dea · audit A · 236 stars
documentation-criteria SKILL.md skill
shinpr/ai-coding-project-boilerplate · .claude/skills-en/documentation-criteria/SKILL.md · Determines which PRD, ADR, UI Spec, Design Doc, and Work Plan a change requires and where each is stored. Use when…
git:20261021.c75adb9 · audit A · 236 stars

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