UX Doc v2 - Review Rubric & Scenarios
CommandTemplates307 words2 min read
Purpose
Phần tiêu đề “Purpose”- Cung cấp bộ kiểm chứng chất lượng cho tài liệu theo chuẩn
Core + Conditional. - Chuẩn hoá cách review để giảm khác biệt giữa người viết và reviewer.
Template compliance scenarios
Phần tiêu đề “Template compliance scenarios”- Scenario A (single-module):
- Required sections theo doc_role profile (xem
rule-doc-standards.md§2). - Không ép thêm section mở rộng khi trigger không thỏa.
- Required sections theo doc_role profile (xem
- Scenario B (cross-module):
- Required sections +
Dependencies / Integration. - Bật thêm
Metrics / Analyticsvà/hoặcState model / Edge caseskhi có trigger.
- Required sections +
- Scenario C (copy-only update):
- Không thay đổi behavior/scope thì giữ nguyên cấu trúc.
- Chỉ cập nhật
Change logkhi thay đổi có impact.
Quality gates
Phần tiêu đề “Quality gates”npm run context:lintphải pass.- Check heading contract:
PurposeElementshoặcElements / ScopeLogichoặcLogic / RulesUI / BehaviorChange log
- Check Need Gate:
- Không có section mở rộng thừa trigger.
- Không có placeholder section.
- Check links:
- Relative path hợp lệ, mở được.
Peer-review rubric (1-5)
Phần tiêu đề “Peer-review rubric (1-5)”Clarity- 1: mơ hồ, khó hành động.
- 3: hiểu được nhưng còn khoảng trống.
- 5: rõ ràng, có thể triển khai ngay.
Decision completeness- 1: thiếu quyết định trọng yếu.
- 3: đủ cho thảo luận, chưa đủ implement.
- 5: quyết định đầy đủ, không cần đoán thêm.
Cross-module coherence- 1: mâu thuẫn với module liên quan.
- 3: có liên kết nhưng chưa chặt.
- 5: đồng bộ rõ với dependencies.
Need-based brevity- 1: thừa nhiều section không cần.
- 3: có một số phần dư.
- 5: đúng mức, đủ dùng, không thiếu/không thừa.
Pass criteria
Phần tiêu đề “Pass criteria”- Mỗi tiêu chí rubric >= 4.
- Không lỗi context lint.
- Không lỗi format change log.