Automated summary
Reviews specification and developer documents against project guidelines, detecting ambiguous expressions, missing sections, and structural issues.
Strengths
- Ensures document consistency
- Reduces ambiguity
- Enforces required sections
- Checks for decisions lacking context
Limitations
- Only works with predefined file types
- Relies on manually defined rules
- May not catch semantic errors
Use when validating documentation before release or during code review.
Do not use for creative or exploratory writing where strict compliance is not needed.
Security analysis
SafeThe skill only uses Read, Glob, and Grep to inspect documentation files. It does not execute any potentially destructive or exfiltrating commands. No network access, no shell execution. The review checks are purely advisory.
No concerns found
How this analysis is madeExamples
Review docs-spec/architecture.md for compliance with project guidelines.Find and review all files in docs-spec/ and docs-site/docs/ directories for compliance issues.Review docs-spec/adr/001-decision.md for required sections (Context, Decision, Consequences).name: review description: Review specification and developer documents for compliance with project guidelines. Use when checking docs-spec/ and docs-site/docs/ for ambiguous expressions or missing required sections. allowed-tools: Read, Glob, Grep
Specification Document Reviewer
Instructions
-
Determine the review target:
- If argument is provided: Review that specific file
- If no argument: Find all files in
docs-spec/anddocs-site/docs/directories using Glob (exclude node_modules)
-
Read each target file
-
Apply the checks below based on file type
-
Output results in this format:
## [filename] ### Issues Found - [Line X] Issue description - Current: "problematic text" - Suggested: "improved text" ### OK (if no issues) No issues found.
Check Rules
Common Checks (All Files)
Prohibited Ambiguous Words
Detect these vague expressions and suggest numeric alternatives:
| Prohibited | Suggestion | |------------|------------| | 高速 | Specify: "< X ms" or "X ops/sec" | | 高品質 | Specify: "MOS > X" or "bitrate X kbps" | | 低遅延 | Specify: "RTT < X ms" or "latency < X ms" | | シンプル | Specify concrete constraints | | 柔軟 | Specify supported options explicitly | | 高い/低い (performance) | Use numeric thresholds | | 最適化 | Specify before/after metrics |
Judgment Reason Check
Flag statements that lack "why" explanation:
- Decisions without Context/Reason
- Technology choices without justification
architecture.md Specific
Required sections (flag if missing):
- [ ] 対応 OS (macOS / Windows / Linux)
- [ ] 使用言語 (e.g., C++20, Rust stable)
- [ ] 音声 I/O (CoreAudio / WASAPI / ALSA / PipeWire)
- [ ] ネットワーク方式 (e.g., WebRTC Native)
- [ ] codec (e.g., Opus 48kHz / 20ms)
- [ ] スレッドモデル
- [ ] リアルタイム制約 (with numeric targets)
ADR Files (docs-spec/adr/*.md)
Required sections:
- [ ]
## Context- Why was this decision needed? - [ ]
## Decision- What was decided? - [ ]
## Consequences- Trade-offs and implications
Flag if:
- Any section is missing
- Context lacks problem statement
- Decision lacks clear choice
- Consequences lacks pros/cons
BDD Files (docs-spec/behavior/*.feature)
Required structure:
- [ ]
Feature:declaration - [ ] At least one
Scenario: - [ ] Each scenario has
Given,When,Then
Flag if:
Thenclause uses unmeasurable terms (suggest defining in architecture.md)- Missing
Givenconditions for environment setup
API Spec Files (docs-spec/api/*.md)
Required for each API:
- [ ] API name
- [ ] 入力 (Input parameters)
- [ ] 出力 (Return value)
- [ ] スレッド制約 (Thread requirements)
- [ ] 呼び出しタイミング (When to call)
Flag if:
- Thread constraints are missing (critical for real-time audio)
- Input/output types are unspecified
docs-site Files (docs-site/docs/**/*.md)
Checks for developer documentation:
Ambiguous Expression Check
Apply same prohibited words as Common Checks.
Note Banner Check
Required at top of each file:
- [ ] Contains
:::notebanner pointing to docs-spec as source of truth
Flag if:
- Note banner is missing
- Note banner doesn't reference docs-spec
Internal Link Check
Flag if:
- Links to
/docs/...paths that don't correspond to existing files - Broken relative links
Consistency Check (intro.md only)
If file contains implementation status table:
- [ ] Phase statuses should match docs-spec/README.md
Example Output
## docs-spec/architecture.md
### Issues Found
- [Line 15] Ambiguous expression detected
- Current: "低遅延な音声通信を実現"
- Suggested: "片方向遅延 < 150ms (RTT < 50ms環境)"
- [Missing] スレッドモデル section not found
- Suggested: Add section describing thread architecture
### Summary
- 2 issues found
- 1 required section missing
## docs-site/docs/intro.md
### Issues Found
- [Line 14] Ambiguous expression detected
- Current: "超低レイテンシ"
- Suggested: Use specific value (e.g., "10ms以下" as already stated on line 22)
### OK
- Note banner present (line 7-10)
- Internal links valid
From the file to a first result
The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.
View the source and supporting filesThis download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.
1. Download the file
Download SKILL.mdFrom the root of a test project, save the file as .skill-downloads/specification-document-reviewer-mm78no1v/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.
Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.
mkdir -p '.skill-downloads/specification-document-reviewer-mm78no1v' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/specification-document-reviewer-mm78no1v/download' --output '.skill-downloads/specification-document-reviewer-mm78no1v/SKILL.md.part' && mv '.skill-downloads/specification-document-reviewer-mm78no1v/SKILL.md.part' '.skill-downloads/specification-document-reviewer-mm78no1v/SKILL.md'2. Check prerequisites
Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.
Tools declared by the author (check availability in your agent): Read, Glob, Grep
No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.
The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.
3. Load the skill
After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.
Claude Code
test -f '.skill-downloads/specification-document-reviewer-mm78no1v/SKILL.md' && test -s '.skill-downloads/specification-document-reviewer-mm78no1v/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/review' && cp -R '.skill-downloads/specification-document-reviewer-mm78no1v' '.claude/skills/review'OpenSkills
OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.
Official OpenSkills installationopenskills install './.skill-downloads/specification-document-reviewer-mm78no1v'openskills read 'specification-document-reviewer-mm78no1v'Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.
For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.
openskills syncManual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.
4. Try a first task
Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:
Read .skill-downloads/specification-document-reviewer-mm78no1v/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.
Supabase Docs Authoring
Documentation
Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.
Create Architecture Decision Record
Documentation
Create a new Architecture Decision Record with sequential numbering, register it in the AgentDB graph, and link related ADRs.
Plan update with deep research
Documentation
Updates a plan document by launching parallel subagents to analyze a topic across all compiler passes, then consolidates findings into the plan doc.