Agent skill

doc-review

Document review via Codex MCP. Use when: reviewing .md docs, tech spec audit, document quality check. Not for: code review (use codex-code-review), test review (use test-review). Output: 5-dimension rating table + gate.

Stars 139
Forks 18

Install this agent skill to your Project

npx add-skill https://github.com/sd0xdev/sd0x-dev-flow/tree/main/skills/doc-review

SKILL.md

Document Review Skill

Trigger

  • Keywords: review doc, document review, tech spec review, review-spec, doc-refactor, streamline doc

When NOT to Use

  • Code review (use codex-code-review)
  • Test coverage review (use test-review)
  • Just want to read a document (use Read directly)

Commands

Command Description Use Case
/codex-review-doc Codex reviews .md docs Document changes
/review-spec Review tech spec Spec confirmation
/doc-refactor Streamline documents Doc too long
/update-docs Research & update docs After code change

Workflow: /codex-review-doc

Determine target → Read content → Codex review (5 dimensions) → Rating table + Gate → Loop if Needs revision

Step 1: Determine Target File

Condition Action
Path specified Use that path directly
No path Auto-detect: git modified .md → staged .md → new .md
Multiple files List and ask user which to review

Step 2: Read File Content

Read target file, save as FILE_CONTENT.

Step 3: Codex Review

First review: mcp__codex__codex with doc review prompt. See references/codex-prompt-doc.md.

Config: sandbox: 'read-only', approval-policy: 'never'

Save the returned threadId.

Loop review: mcp__codex__codex-reply with re-review template. See references/review-loop-doc.md.

Step 4: Consolidate Output

Organize results into rating table + severity-grouped findings + gate.

Review Dimensions

Dimension Checks
Architecture Design System boundaries, responsibilities, dependencies, extensibility
Performance Bottlenecks, concurrency, caching, resource usage
Security Data leakage, access control, input validation, error handling
Documentation Quality Structure, completeness, accuracy, examples, docs-writing standards
Code Consistency Pseudocode matches codebase, referenced files exist, technical accuracy

Review Loop

⚠️ @CLAUDE.md auto-loop: fix → re-review → ... → ✅ PASS ⚠️

⛔ Needs revision → fix 🔴 items → /codex-review-doc --continue <threadId> → repeat until ✅ Mergeable.

Max 3 rounds. Still failing → report blocker.

Verification

  • Each issue tagged with severity (🔴/🟡/⚪)
  • Gate is clear (✅ Mergeable / ⛔ Needs revision)
  • Codex verified code-documentation consistency independently

Required Actions

Change Type Must Execute
.md docs /codex-review-doc or /review-spec
Tech spec /review-spec
README /codex-review-doc

References

  • Doc review prompt: references/codex-prompt-doc.md
  • Review loop: references/review-loop-doc.md
  • Standards: @rules/docs-writing.md

Examples

Input: /codex-review-doc docs/features/xxx/tech-spec.md
Action: Read file → Codex doc prompt → Rating table + Findings + Gate

Input: /codex-review-doc
Action: Auto-detect changed .md → Codex doc prompt → Rating table + Gate

Input: Review this tech spec for me
Action: /review-spec → Check completeness/feasibility/risks → Output Gate

Input: This document is too long, streamline it
Action: /doc-refactor → Tabularize + Mermaid → Output comparison

Expand your agent's capabilities with these related and highly-rated skills.

sd0xdev/sd0x-dev-flow

runbook

Generate and update feature release runbooks from existing docs and codebase. Use when: creating operational runbook, release handbook, deployment checklist, pre-release preparation. Not for: incident response (v2), code review (use codex-code-review), architecture design (use architecture).

139 18
Explore
sd0xdev/sd0x-dev-flow

ask

Context-aware Q&A with auto context gathering. Use when: user has a quick question about codebase, git history, rules, docs, or skills during development. Not for: code changes (use feature-dev), code review (use codex-review-fast), deep research (use deep-research), full code trace (use code-explore). Output: structured answer with source attribution.

139 18
Explore
sd0xdev/sd0x-dev-flow

project-brief

Convert a technical spec into a PM/CTO-readable executive summary. Simplify technical details, focus on business value.

139 18
Explore
sd0xdev/sd0x-dev-flow

codex-test-gen

Generate unit tests for specified functions using Codex MCP

139 18
Explore
sd0xdev/sd0x-dev-flow

bug-fix

Bug fix workflow. Use when: fixing bugs, resolving issues, regression fixes. Not for: new features (use feature-dev), understanding code (use code-explore). Output: fix + regression test + review gate.

139 18
Explore
sd0xdev/sd0x-dev-flow

skill-health-check

Validate skill quality against routing, progressive loading, and verification criteria. Use when: auditing skills, checking skill health, reviewing skill design. Not for: code review (use codex-code-review) or doc review (use doc-review). Output: health report with per-skill ratings + Gate.

139 18
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results