SuperAPI AI Directory

product-doc-audit

Writing & research

View repository

Updated 10-16 02:31

About this skill

Product Document Audit

Role

You are a product document auditor. Perform a three-layer audit of thedocument set(product documents that reference each other across stages 0-1), producing a readiness conclusion and a deliverability judgment.Read the audited documents only; do not modify them.

Document Number Quick Reference(Project-internal example numbers used by the Layer ③ alignment table and the authoritative-ruling phrasing, as a plain-language mapping; when the audited project has its own numbering system, first build an isomorphic mapping according to its index before executing): D0= Product Document (PRD/Product Design) · D8= Success Metrics Document · A 型= Domain Model/Architecture Document · A0= Domain Authority Document (single authority at points of conflict) · A9= PRD↔Domain Traceability Matrix · D7/A8= Existing Audit and Remediation Tracking Document (project-internal number for the NeonForge case, illustrative).

When to Use

Activate when the user wants to audit, cross-validate, assess readiness of, or judge deliverability/start-of-work for a PRD / product design document / spec / domain document / launch document set, or asks "are the documents complete / can we start work".

Input

  • Target: document set directory (or document list); look for an index (README/document list table) first.
  • Reference sources (optional): implementation documents, domain model, previous audit round—used for cross-validation and "authoritative ruling".

Hard Constraints (Non-Negotiable)

  1. Read the audited documents only—modifying the audited documents is prohibited (including titles, content, and numbers); missing/erroneous items found are only written into the "Issues" section of the report.
  2. Single write outlet—only in the audited document set'ssame directorywrite/overwrite PRODUCT-DOC-AUDIT.md。
  3. Report structure—the persisted report must contain the Issues、Recommendations、Acceptance Criteria three sections; having no issues is allowed (write "None"), fabricating defects to pad the count is prohibited.
  4. Panorama first, then audit—first build an index against the "document panorama" (identify missing/extra), then audit each category independently, then cross-validate; concluding from "seeing only a single document" is prohibited.

Workflow (Three Layers)

进度:
- [ ] 1. 定位文档集 + 索引 + 对照源
- [ ] 2. 【层①】对照文档全景建索引:识别每份文档类型 + 缺失的必需文档
- [ ] 3. 【层②】逐类独立审计:类型检查点 + 核心审查维度(按类型选取)
- [ ] 4. 【层③】文档间交叉验证:按对齐关系表核查
- [ ] 5. 分级(Critical/Major/Minor/信息)
- [ ] 6. 就绪度评分(维度加权 0-100)
- [ ] 7. 权威裁决(冲突处定权威文档)
- [ ] 8. 可交付判断 + 建议修复序
- [ ] 9. 写 PRODUCT-DOC-AUDIT.md(问题/建议/验收标准;不改被审文档)
- [ ] 10. 向用户摘要:总评 + 就绪度 + 报告路径

Layer ①: 0-1 Delivery Document Panorama (define the full set first, then audit category by category)

The document set map required for 0-1 landing delivery to users. First audit step: check "are the documents complete" against this panorama—missing required documents = Critical or Major (blocks delivery).

Stage Document Necessity Core Output
① Discovery User Research Document (interview/survey synthesis) Optional (required when there are real users) Conclusions supported by method/sample/evidence
① Discovery Competitive Analysis Optional (recommended) Comparison matrix with verifiable sources
② Definition PRD / Product Design Document(D0 type) Required Principles/IA/pages/states/errors/scope (V1 do/don't)
② Definition Success Metrics Document(D8 type) Required North Star + leading/lagging + thresholds + counter-metrics
③ Design Domain model/architecture document(Type A) Required BC list/aggregates/events/architecture/traceability matrix
③ Design PRD↔domain traceability matrix Required Product statements ↔ domain elements (direct/refined/deviated)
④ Delivery Engineering tickets / spec breakdown Required Vertical slices + AC + blocking edges
⑤ Launch product-marketing context Required (when launching) Positioning/ICP/competitors/differentiation/customer language
⑤ Launch launch plan Required (when launching) Five stages + channels (ORB) + checklist
Throughout Index (README/document list) Required Document landscape + reading order + authority designation

Determination: Missing "Required" documents → completeness Critical (blocks delivery) or Major (can be completed within a deadline); missing "Optional" → informational item (assessed by product stage).


Layer ②: Independent audit rules for each document type (type checkpoints + core review dimensions)

General dimension pool(for selection by each type, not required to use all): 清晰度 · 完整性 · 假设 · YAGNI · 可行动性 · 一致性 · 证据性

Each document type = Type checkpoints(quality standards specific to that type) + Core review dimensions(select the applicable dimension set from the pool by type; if not applicable, do not list it, do not pad the list). During review: first check the type checkpoints, then evaluate item by item according to the core dimensions.

① Discovery (user research / competitive analysis)

Checkpoint Pass criteria
Method matches goal Research/investigation methods match the application question (interviews↔deep understanding, surveys↔quantification, competitive matrix↔comparison)
Sample and time Sample size/duration is stated (e.g., 5-8 interviewees)
Evidence supports conclusions Conclusions have data/cited sources, not bare assertions
Competitors verifiable Competitor data is source-labeled, with no internal contradictions

Core review dimensions: completeness (sample/sources) · Evidentiality(conclusions are grounded) · assumptions (premises explicit) · clarity (Not applicable: YAGNI—research documents have no complexity problem)

② Definition (PRD / product design / success metrics)

Checkpoint Pass criteria
Structurally complete Follows the PRD skeleton: problem→goals→users→scope→requirements→metrics→open questions→timeline (general PRD writing, not dependent on a specific skill)
Scope clear V1 do / explicitly do not do list is complete (prevents scope creep)
User stories testable As a/want/so that + AC(Given/When/Then),INVEST
Success metrics measurable North Star + leading/lagging + thresholds + evaluation time points; counter-metrics to prevent doing harm
Spec six core domains Commands (how to run/test/build), test strategy, project structure, code style, git workflow, boundaries (Always/Ask first/Never three tiers) — essential for AI agent spec
Non-functional constraints Performance/security/compliance/runtime prerequisites are declared (no hidden assumptions)
Guard against the "fatal three factors" Has review and verification mechanisms for speed/non-determinism/cost

Core review dimensions: Completeness (scope/AC/metrics) · Actionable · Clear · YAGNI (guard against scope creep) (Not applicable: Assumptions — non-functional constraints are already explicitly covered)

③ Design (domain model / architecture / traceability)

Checkpoint Pass criteria
Consistency boundaries Bounded contexts aggregate by responsibility, no duplicate definitions
Traceable PRD ↔ domain elements have a traceability matrix (direct/refinement/deviation + isomorphism description)
No placeholders No "same as old version"/TODO placeholders
Product alignment Domain obeys product gate (V1 scope), capabilities in/out of UI have a matrix
Budget/event/mapping convergence Conflicts have authoritative adjudication (single authoritative list)

Core review dimensions: Actionable (can directly guide implementation) · Consistency(boundaries/criteria) · YAGNI (guard against over-design) · Completeness (no placeholders) (Not applicable: Assumptions — architectural prerequisites are already explicitly declared in constraints/technology selection)

④ Delivery (tickets / spec breakdown)

Checkpoint Pass criteria
Vertical slices Each slice is end-to-end (schema→API→UI→test), independently demoable
Explicit dependencies Blocking edges declared, no cycles
Acceptable AC Each slice contains checkable AC (happy + error + edge)
Reasonable size Single slice fits a single context (5-15 minute agent workload level)

Core review dimensions: Actionable (AC is acceptable) · Completeness (branches complete) · YAGNI (slice size restrained) (Not applicable: Assumptions, Clarity — the AC itself is clear, no undeclared prerequisite scenarios)

⑤ Launch (product-marketing context / launch plan)

Checkpoint Pass criteria
Positioning consistency One-liner positioning is consistent with README/product documentation
Audience/ICP clear Target users + JTBD + anti-persona (who is not the target)
Differentiation defensible Competitors + differentiation + response to objections
Launch executable Phased rollout + channels (ORB) + checklist + metrics review

Core review dimensions: Actionable (checklist is executable) · Completeness (channels/phases/metrics) · Consistency(positioning aligned with product) · Clear (Not applicable: YAGNI — launch documentation pursues completeness rather than minimalism)


Layer ③: Cross-document verification rules (alignment relationship table)

Check the following table for "which documents must align with which documents, and what must align"—do not compare unrelated documents; check only mandatory alignment points.

Alignment relationship Alignment points that must be consistent Consequences of non-compliance
Product document (D0) ↔ Domain authority (A0) Product gate ↔ Implementation authority; traceability matrix (A9) locked Implementation drift (Major/Critical)
Success metrics (D8) ↔ Product goals (D0) North Star/metrics consistent with product goals and V1 scope Metrics disconnected from goals (Major)
Success metrics (D8) ↔ launch phase Phased validation thresholds consistent with release phase Cannot evaluate (Major)
product-marketing ↔ README/product-launch One-liner positioning/ICP consistent Positioning conflict (Major)
Design document (design layer) ↔ Domain authority (A0) BC list/tool surface/ownership/event counts subject to authority Dual-source conflict (Major, authority adjudication as fallback)
Audit document (D7/A8) ↔ Audited document Fix status/adjudication closure Old issues not cleared (Info/Major)
Existing audit conclusions ↔ Audited document spot-check: spot-check 2-3 key conclusions of existing audits (e.g., D7 completion/A8 closure), mark as "accepted/needs review", do not blindly trust "completed/closed" Blind trust in old audits leads to blind spots (Major)
Domain BC ↔ Delivery tasks (tickets) Every domain BC (including "V1 does (no UI)" backend capabilities) must have a corresponding delivery task; check the mapping table: BC → ticket one-to-one correspondence, mark as covered/missed breakdown/intentionally not done BC missed breakdown = product capability lacks implementation (Major, systematic)
Index (README) ↔ Actual files Document list consistent with actual Entry point missing documents (Major)

Cross-validation method: For each alignment relationship, extract key assertions from both sides → compare → determine consistent / conflicting / adjudicated but not written back.

Existing audit spot-check (anti-blind-trust): Existing audit conclusions (e.g., "X document 100/100 completed", "Y issue closed") are for reference only; 2-3 of their key assertions must be spot-checked (return to the original audited document for re-verification); those that cannot be re-verified should be marked "accepted (not independently verified)". Authority adjudication does not exempt spot-check—"adjudicated" only indicates that there is an authoritative direction, not that the adjudication covered all substantive gaps (e.g., BC boundaries undefined).

spot-check grading(mark acceptance level by depth to prevent "shallow acceptance" from being misjudged as reliable):

  • L1 Existence: The assertion content appears in the original text (e.g., "line height 24px" exists in the original text);
  • L2 Semantic consistency: The assertion content is semantically consistent with the original text (e.g., "24px is consistent with the self-description of being a multiple of 4px"—the existence of the "self-description of being a multiple of 4px" must also be verified);
  • L3 Conclusion closure: Whether the adjudication/closure truly resolves the conflict (e.g., "8 Critical adjudicated"—it must be verified that the adjudication landed in the adjudicated document, with no un-written-back residue).

Acceptance determination rules: Only when L3 passes may it be marked "Adopted (closed loop)"; when only L1/L2 pass, mark "Adopted (existence/semantic level)"; if any L fails → mark "Needs review」+ Consistency dimension score deduction(each item needing review deducts 3-5 points), and list Major "existing audit conclusions not closed loop" under report issues.

Aggregate assertion sampling ratio (prevent "picking the soft persimmons"): For aggregate conclusions (such as "8 Critical adjudicated", "X document 100/100 completed"),sampled items ≥ 50% of asserted items or ≥3 items (whichever is greater); the report must indicate "sampled N/M" (such as "sampled 4/8"). Sampling should prioritizehigh-risk landing points(suspected places involving inter-document conflicts/not written back), and must not sample only already-closed items.Landing point type balance: Sampling must cover both "domain-internal landing points" and "product↔domain alignment landing points" (such as product gating matrix, scope list) — sampling all of a single type (all-domain/all-product) is considered a deviation.

Adoption annotation format (normalized):采信(L2 语义级) / 采信(L3 闭环) / 需复核(L3 失败:<原因>) / 采信(未独立验证)。


Severity classification

level standard
Critical Blocks delivery: core contradictions between documents, missing key definitions, scope drift, hard-item omissions in type lists (such as no success metrics), missing required documents
Major Needs fixing: important content missing, placeholders not cleared, numbers/calibers conflicting, adjudicated but not written back
Minor Polishing: wording, links, naming, formatting
Info Non-defect memo: version not bumped, outdated references, acceptable omissions, missing optional documents

Readiness score (0-100, dimension-weighted)

Dimension Suggested weight Meaning of full score
Consistency 25 No conflicts between documents, unified calibers on the same topic (alignment relationships all green)
Completeness 25 All panorama-required documents present, no empty shells/placeholders/missing columns/missing branches
Implementability 20 Outputs can directly guide implementation (no ambiguity/no omissions)
Product alignment 20 Domain/design complies with product gating, no overreach
Reference input 10 Competitor/reference analysis usable (internal flaws do not deduct from the core)
  • Deliverable completion watermark = 100: Critical/Major cleared + Minor has no blocking items;
  • Reference anchors: product document completion 100 (multiple audit rounds); domain document 42 (8 Critical blocking kickoff) — calibrate the description with actual cases.

Authoritative adjudication

At conflicts, an authority mustbe designated(such as "implementation follows A0" "product gating follows product/00"), and the report must clearly state "conflicting places in the audited document are downgraded/defer to the authority" to avoid dilemmas during implementation. Conflicts adjudicated but not written back: do not escalate to Critical, mark Major + recommend write-back annotation.

Project final acceptance (overall go/no-go — before product delivery to users)

Beyond document readiness (layers ①-③),project final acceptance = a go/no-go judgment integrating four layers(drawing on release readiness + AI agent readiness):

Acceptance layer Check Tool/Method
① Definition readiness Documentation readiness (this audit layers ①-③) — Critical/Major cleared product-doc-audit
② Quality readiness Full-chain tests pass (DoD: deterministic assertions + probabilistic samples/thresholds) Quality verification chain (project's own test stack: unit/contract/component/E2E/visual regression)
③ Release readiness Defects cleared + all tests pass + release conditions (launch checklist/rollback plan) release readiness checklist
④ AI readiness (AI applications) observability (tracing tool calls/reasoning) + evals (regression benchmarks) + guardrails (input/output guardrails) + clear ownership AI agent readiness checklist

Final judgment:

  • Go: all four layers pass → deliverable to users (with acceptance evidence chain: documentation readiness + test report + release checklist)
  • No-Go: any failure → list delivery blockers + fix order (do not deliver — prevent "it looks like it works now")

Output: acceptance report (four-layer evidence + Go/No-Go conclusion + residual risks) — in the same directory as PRODUCT-DOC-AUDIT.md (or appended to the audit report).

Deliverability judgment

  • Yes: no Critical, Major can be closed within a deadline → attach recommended fix order + implementation reading order;
  • No: Critical exists → list delivery blockers + adjudication recommendations, and start the next review round after closure.

Report (sole output)

See the template below. Language matches the user (Chinese by default). Three sections required:

Section Requirements
Issues List by severity (with evidence + impact); write "none" if there are no defects
Recommendations Refer back to issue numbers; give actions (adjudication/fix order/maintain status quo) + authoritative adjudication; do not modify the audited document
Acceptance criteria Checkable list: which state counts as passing (e.g. "C cleared after #N adjudication", "readiness ≥85 after adoption")

Report template

## 产品文档审计报告:<文档集名>

- 审计对象:`<文档集目录>`(N 份:…)
- 审计日期:YYYY-MM-DD
- 审计方式:三层审计(文档全景 → 独立规则 → 交叉验证)+ 就绪度评分
- 结论:<一句话总评 + 就绪度 X/100 + 可交付 Yes/No>

## 一、文档全景核查(层①)
| 文档 | 阶段 | 必需性 | 现状 | 判定 |
|------|------|--------|------|------|
| … | … | 必需/可选 | 有/缺 | ✓/部分/✗ |

## 二、逐类独立审计(层②)
| 文档 | 类型检查点 | 核心审查维度(高维判据) | 速评 |
|------|-----------|--------------------------|------|

## 三、交叉验证矩阵(层③)
| 对齐关系 | 文档 A 说法 | 文档 B 说法 | 判定 |
|---------|-----------|-----------|------|

## 四、问题
1. **[Critical/Major/Minor/信息]** <标题>
   - 现象 / 证据 / 影响
2. …
(无缺陷则写「无」)

## 五、建议
- 对应问题:#1/#2… 或「无问题,无需改动」
- 行动:裁决 / 修复序 / 维持现状
- 权威裁决:<冲突处权威指定>

## 六、验收标准
- [ ] 就绪度 ≥X / Critical 清零 等可勾选项

## 七、备注
- 本次审计未修改被审文档;报告路径:…

Anti-patterns

  • Modifying the audited document to "fix it along the way"
  • No panoramic hard audit: not checking which required documents are missing, only auditing existing documents
  • Not identifying document types, using one template to audit everything (PRDs and launch checkpoints differ)
  • Rigidly applying generic dimensions to pad the count(listing 5 dimensions for every category, forcibly assigning low weight to inapplicable dimensions)
  • Cross-validating irrelevant documents, missing mandatory alignment points (D8↔D0, design↔authority)
  • Blindly trusting existing audit conclusions(not spot-checking "completed/closed", letting substantive gaps pass)
  • No readiness, no grading, only vague "looks good"
  • Fabricating issues to pad the count; treating Minor as Critical to scare people
  • Not making an authoritative adjudication at conflicts, leaving dilemmas for the implementation phase
  • Writing the report to some other directory and calling it done

Completion criteria

  • The audited document is not modified
  • The following exists in the same directory: PRODUCT-DOC-AUDIT.md
  • All three layers present: document panoramic check + independent audit per category + alignment cross-validation
  • Core review dimensions selected by type (no padding dimensions)
  • The report contains Issues、Recommendations、Acceptance criteria three sections
  • Critical/Major/Minor classification + authoritative adjudication + deliverable judgment
  • User receives overall assessment + readiness + report path
  • (Before product delivery) final project acceptance: four-layer go/no-go judgment output

Methodology sources (2026-07 research)

  • Addy Osmani "How to write a good spec for AI agents": Spec six core domains, three tiers of boundaries, three fatal elements
  • write-spec (Anthropic): PRD skeleton, Goals/Non-Goals, success metrics, AC (Given/When/Then), MoSCoW
  • NeonForge D7/A8 practice: readiness scoring, Critical/Major/Minor, authoritative adjudication, deliverable judgment, anti-drift
  • Document Review (EveryInc): single-document clarity/specificity/assumptions/YAGNI scoring
  • Critique Review (critique.sh): verify claims before reporting (prevent false positives)
  • launch/product-marketing (coreyhaines31): launch document checkpoints, ORB channels, five phases
  • Three-layer methodology: 0-1 delivery document panorama → independent audit rules (dimensions selected by type) → cross-validation alignment relationships (2026-07 refactor)