Back to Details

review-spec

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
Review the given spec document by analyzing both the spec AND the referenced codebase.
通过同时分析规格文档和关联的代码库，对给定的规格文档进行评审。

Process

评审流程

  1. Read the spec - Understand goals, phases, and proposed changes
  2. Explore the codebase - Read files and code mentioned in the spec
  3. Analyze patterns - Identify existing patterns, conventions, and architecture
  4. Validate the plan - Ensure proposals align with codebase reality
  5. Identify issues - Find gaps, risks, and improvement opportunities
  1. 阅读规格文档 - 理解目标、阶段和拟议的变更
  2. 调研代码库 - 查看规格文档中提及的文件和代码
  3. 分析现有模式 - 识别已有的模式、规范和架构
  4. 验证方案合理性 - 确保拟议内容与代码库实际情况一致
  5. 识别问题 - 找出差异、风险和改进机会

Review Dimensions

评审维度

Evaluate across these areas (focus on what's relevant):
  • Architecture: Component boundaries, data flow, API contracts, separation of concerns
  • Feasibility: Implementation complexity, technology trade-offs, effort estimation
  • Reliability: Error handling, retries, idempotency, graceful degradation
  • Performance: Bottlenecks, caching, query patterns, scaling approach
  • Security: Auth, data protection, input validation, audit logging
  • Edge Cases: Null handling, limits, timeouts, race conditions, partial failures
  • Testing: Testability, integration strategy, rollback considerations
从以下维度进行评估（聚焦相关内容）：
  • 架构：组件边界、数据流、API契约、关注点分离
  • 可行性：实现复杂度、技术取舍、工作量估算
  • 可靠性：错误处理、重试机制、幂等性、优雅降级
  • 性能：瓶颈、缓存、查询模式、扩容方案
  • 安全性：Auth、数据保护、输入校验、审计日志
  • 边界情况：空值处理、限制条件、超时、竞态条件、部分失败
  • 测试：可测试性、集成策略、回滚考量

Output Format

输出格式

For each finding:
undefined
针对每个发现的问题：
undefined

[Finding Title]

[问题标题]

Category: Architecture | Feasibility | Reliability | Performance | Security | Edge Case | Testing Severity: Critical | High | Medium | Low Section: [Spec section or phase]
Issue: [Clear problem description] Recommendation: [Specific, actionable change] Rationale: [Technical justification]
undefined
类别：架构 | 可行性 | 可靠性 | 性能 | 安全性 | 边界情况 | 测试 严重程度：关键 | 高 | 中 | 低 规格章节：[规格文档章节或阶段]
问题描述：[清晰的问题说明] 建议方案：[具体可执行的变更措施] 理由：[技术层面的论证]
undefined

Guidelines

评审准则

  • Verify against code - Don't trust the spec blindly; check actual implementations
  • Follow existing patterns - Recommendations should align with codebase conventions
  • Be specific - Reference exact files, functions, and line numbers
  • Prioritize - Order findings by severity and impact
  • Challenge assumptions - Question decisions that lack justification
  • 对照代码验证 - 不要盲目信任规格文档，需核查实际实现
  • 遵循现有模式 - 建议需与代码库的规范保持一致
  • 内容具体化 - 引用确切的文件、函数和行号
  • 按优先级排序 - 根据严重程度和影响对问题进行排序
  • 质疑假设 - 对缺乏依据的决策提出疑问