Documentation Criteria

Community

shinpr

documentation-criteria

変更に必要なPRD、ADR、UI Spec、Design Doc、作業計画書と、それぞれの保存先を判定する。ドキュメントの範囲を決める時、または技術ドキュメントを作成・レビューする時に使用。

Overview

Publisher	shinpr
Repository	`ai-coding-project-boilerplate`
Skill name	`documentation-criteria`
Stars	234
Forks	28
Bundled files	6
License	MIT
Links	Skill source Repository

Markdown instructions
A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.
Works with any LLM
AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.
6 bundled files
Scripts, templates, and references the model can read while it works. Files are read-only and never executed.
Open source
Published by shinpr on GitHub. Read the source before you install it.

Installation

Install the Documentation Criteria AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

Open the app and go to Plugins → Skills.
Choose "Install from GitHub".
Paste the skill folder URL below and confirm.
https://github.com/shinpr/ai-coding-project-boilerplate/tree/main/.claude/skills-ja/documentation-criteria
Enable the skill in any chat where you want it available.

Store

Installed

Skills

Add skills

Import one or more skills from a public GitHub folder or a local .skill or .zip archive, or SKILL.md file.

From GitHub URLFrom .skill, .zip, or SKILL.md

GitHub repo or folder

https://github.com/shinpr/ai-coding-project-boilerplate/tree/main/.claude/skills-ja/documentation-criteria

Points to a single skill folder, or any folder that contains multiple skills. Public repos only.

CancelContinue

Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills

git clone --depth 1 https://github.com/shinpr/ai-coding-project-boilerplate.git /tmp/ai-coding-project-boilerplate
mkdir -p .claude/skills
cp -r /tmp/ai-coding-project-boilerplate/.claude/skills-ja/documentation-criteria .claude/skills/documentation-criteria

Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Documentation Criteria in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Documentation Criteria on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Documentation Criteria is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

Loaded only when it is needed
The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.
Switch models mid-chat
Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

ドキュメント作成基準

このスキルはドキュメントの振り分け、すなわち変更に伴って記録すべき、後続作業に長く影響する判断と各ドキュメントの保存先を定める。各ドキュメントの内容と構造の要件は、「保存場所」からリンクされた各テンプレートが定める。

各ドキュメントで確定すること

PRD — 後続作業のトレーサビリティの基点となるビジネス成果、現時点の要件、対象外、受入条件を確定する。AC IDは設計と検証で使う安定したトレーサビリティキーとする。実装設計はDesign Doc、技術的な選択肢の決定はADR、タスクの順序は作業計画書に記載する
ADR — 後続作業に長く影響する技術判断を1つと、それが退けた実質的に異なる選択肢を記録し、後続作業が承認済みの判断と偶発的な実装を区別できるようにする。Accepted は現時点で選ばれている手段を記録したものであり、維持する義務ではない。確認済みの成果、将来状態の要件、対象外を維持したまま、より小さく十分な選択を後のエビデンスが支持する場合は、そのADRを更新または置き換える。完全な実装設計はDesign Docに記載する
UI Spec — 実装前に画面構造、遷移、コンポーネントと状態の契約、インタラクション、ビジュアル受入条件を記録する。これらの判断が未確定の場合に限って作成する。承認済みのUI Specがある場合は再利用し、リポジトリの代表的なエビデンスから判断できる場合はDesign Docへ進む
Design Doc — 確認済みスコープに対する完全な実装設計として、責務、フロー、契約、変更影響、検証境界を記録する。実装では主要な技術基準として扱い、不足している実現方法を黙って作り出さない。この基準に書かれた内容はそのまま計画・実装の作業になるため、リリース実行や本番運用など、リポジトリの変更以外の作業は記載しない。そうした作業を述べる確認済みの要件は、その作業が使う機能を設計することで満たす。リポジトリのエビデンスによって技術的な実現方法が成立しないと分かった一方で、確認済みの成果、将来状態の要件、対象外を維持できる場合は、プロダクト要件を再検討せず、担当するワークフローで実装と影響を受ける技術成果物を修正する
作業計画書 — 依存順序、タスク境界、実行可能な検証、最初に有用な証明を得る地点を確定する。設計詳細は再掲せず参照する
タスクファイル — 作業計画書の実行可能な成果1つについて、根拠となる情報源、調査の開始地点、書き込み責務、観測可能な検証を実装へ引き継ぐ

作成判定マトリクス

構造スケール	基本ドキュメント	作成順序
小規模	なし	直接実装
中規模	Design Doc、作業計画書	Design Doc -> 作業計画書
大規模	PRD、Design Doc、作業計画書	PRD -> Design Doc -> 作業計画書

フロントエンドまたはフルスタックの作業でUIに関する判断が未確定の場合は、Design Docの前にUI Specを追加する。適格なADRバッチはDesign Docの前に完了させる。適格なADRがある場合、スケールは最低でも中規模とする。

大規模変更のPRD要件は、新規PRDの作成、関連PRDの更新、現行のプロダクト文書がない場合のリバースPRD作成のいずれかで満たす。どのスケールでも、プロダクトスコープが変わる場合は既存PRDを更新する。

構造スケール

分類するのはリポジトリ上のレイアウトではなく判断負荷である。ファイル数は補助的なエビデンスにとどまる。

スケール	判断負荷
小規模	まとまった成果が1つで、1つの責務境界の中にリポジトリの根拠がある明白な実装が1つあり、後続作業に長く影響する未解決の選択がない
中規模	まとまった成果が1つで、境界の調整を伴うか、後続作業に長く影響しうる選択を含む
大規模	独立して価値を持つ成果が複数あり、それぞれ別個の設計判断を要する

レイヤーをまたぐ実装であっても、まとまった成果1つに資する場合は中規模のままでよい。

ADR判定フィルタ

確認済みの実装スコープ内にある技術的な論点ごとに、選択（Choice）フィルタ、次いで長期影響（Durability）フィルタを適用する。新たな記録を作る前に、承認済みADRを確認する。

選択に判断を要する — 確認済み要件、承認済みの判断、リポジトリの代表的なエビデンスを適用した後も、妥当かつ実質的に異なる選択肢が2つ以上残る。
選択が後続作業に長く影響する — 選択によって、後続作業が維持または理解すべき責務、依存方向、共有契約、永続化、技術、可逆性、ライフサイクルコストのいずれかが実質的に変わる。

両方のフィルタを通過した論点ごとにADRを1つ作成し、バッチ全体をまとめてレビューする。一緒に選択または再検討しなければならない判断はまとめ、独立して再検討できる判断は分ける。ローカルな実装詳細や、安価に元へ戻せるその他の選択はDesign Docに記載する。

保存場所

ドキュメント	パス	命名規則	テンプレート
PRD	`docs/prd/`	`[feature-name]-prd.md`	prd-template.md
ADR	`docs/adr/`	`ADR-[4-digits]-[title].md`	adr-template.md
UI Spec	`docs/ui-spec/`	`[feature-name]-ui-spec.md`	ui-spec-template.md
UI Specアセット	`docs/ui-spec/assets/{feature-name}/`	プロトタイプコードファイル	-
Design Doc	`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`（frontendを含む計画のbackend）、`{plan-name}-frontend-task-{NN}.md`（frontend）	task-template.md

生成パスの可変部分は、小文字ASCIIのkebab-case slugとする。非ASCIIの入力はパス作成前にこの形式へ変換する。

作業計画書は.gitignoreで除外される。

参照資料

各テンプレートが、そのドキュメントの内容、ステータス規則、必要なエビデンス、任意の図、完了条件を定める。作成またはレビューするドキュメントのテンプレートだけを読み込む。

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Documentation Criteria AI skill do?

Why use Documentation Criteria on TypingMind?

Because you install it once and use it with any model. Documentation Criteria is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Documentation Criteria in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/shinpr/ai-coding-project-boilerplate/tree/main/.claude/skills-ja/documentation-criteria. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Documentation Criteria?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Documentation Criteria?

As many as you like. As long as a model supports skills, you can use Documentation Criteria with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Documentation Criteria AI skill free?

Yes. It is published on GitHub by shinpr under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Improve Codebase Architecture

mattpocock

CommunityPopular

Scan a codebase for deepening opportunities, present them as a visual HTML report, then grill through whichever one you pick.

Grilling

Grill the user relentlessly about a plan, decision, or idea. Use when the user wants to stress-test their thinking, or uses any 'grill' trigger phrases.

Teach

Teach the user a new skill or concept, within this workspace.

Api Design

Patrones de diseño REST API incluyendo nomenclatura de recursos, códigos de estado, paginación, filtrado, respuestas de error, versionado y rate limiting para APIs de producción.

Overview

Installation

Install in TypingMind

Install in another agent

Use it in TypingMind

Works with any AI model

Skill instructions

ドキュメント作成基準

各ドキュメントで確定すること

作成判定マトリクス

構造スケール

ADR判定フィルタ

保存場所

参照資料

Bundled files

Frequently asked questions

Related AI Skills

Set up your own AI workspace now