feature-spec
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseSoftware Engineering Feature Specification and Planning Best Practices
软件工程功能规格说明与规划最佳实践
Comprehensive feature specification and planning guide for software engineers, product managers, and technical leads. Contains 42 rules across 8 categories, prioritized by impact to prevent scope creep and ensure project success.
本指南为软件工程师、产品经理和技术负责人提供全面的功能规格说明与规划指导,包含8个类别下的42条规则,按影响优先级排序,用于防止范围蔓延并确保项目成功。
When to Apply
适用场景
Reference these guidelines when:
- Writing PRDs or feature specifications
- Defining requirements or user stories
- Managing scope and preventing scope creep
- Prioritizing features and backlog items
- Handling change requests
- Aligning stakeholders on project goals
在以下场景中参考本指南:
- 撰写PRD或功能规格说明
- 定义需求或用户故事
- 管理范围并防止范围蔓延
- 确定功能与待办事项的优先级
- 处理变更请求
- 协调利益相关者对齐项目目标
Rule Categories by Priority
按优先级划分的规则类别
| Priority | Category | Impact | Prefix |
|---|---|---|---|
| 1 | Scope Definition | CRITICAL | |
| 2 | Requirements Clarity | CRITICAL | |
| 3 | Prioritization Frameworks | HIGH | |
| 4 | Acceptance Criteria | HIGH | |
| 5 | Stakeholder Alignment | MEDIUM-HIGH | |
| 6 | Technical Specification | MEDIUM | |
| 7 | Change Management | MEDIUM | |
| 8 | Documentation Standards | LOW | |
| 优先级 | 类别 | 影响程度 | 前缀 |
|---|---|---|---|
| 1 | 范围定义 | 关键 | |
| 2 | 需求清晰度 | 关键 | |
| 3 | 优先级框架 | 高 | |
| 4 | 验收标准 | 高 | |
| 5 | 利益相关者对齐 | 中高 | |
| 6 | 技术规格说明 | 中 | |
| 7 | 变更管理 | 中 | |
| 8 | 文档标准 | 低 | |
Quick Reference
快速参考
1. Scope Definition (CRITICAL)
1. 范围定义(关键)
- - Define explicit scope boundaries
scope-define-boundaries - - Document all assumptions explicitly
scope-document-assumptions - - Break scope into measurable work items
scope-work-breakdown - - Define MVP before full feature set
scope-define-mvp - - Get stakeholder signoff on scope
scope-stakeholder-signoff
- - 明确界定范围边界
scope-define-boundaries - - 明确记录所有假设条件
scope-document-assumptions - - 将范围拆解为可衡量的工作项
scope-work-breakdown - - 在确定完整功能集之前先定义MVP
scope-define-mvp - - 获取利益相关者对范围的签字确认
scope-stakeholder-signoff
2. Requirements Clarity (CRITICAL)
2. 需求清晰度(关键)
- - Write specific, measurable requirements
req-specific-measurable - - Structure requirements as user stories
req-user-stories - - Avoid solution-specific language
req-avoid-solution-language - - Separate functional and non-functional
req-functional-nonfunctional - - Use consistent terminology
req-consistent-terminology - - Maintain requirements traceability
req-traceability
- - 撰写具体、可衡量的需求
req-specific-measurable - - 以用户故事的形式构建需求
req-user-stories - - 避免使用特定解决方案的语言
req-avoid-solution-language - - 区分功能性需求与非功能性需求
req-functional-nonfunctional - - 使用统一的术语
req-consistent-terminology - - 保持需求的可追溯性
req-traceability
3. Prioritization Frameworks (HIGH)
3. 优先级框架(高)
- - Use MoSCoW prioritization method
prio-moscow-method - - Apply RICE scoring for objectivity
prio-rice-scoring - - Map value vs effort explicitly
prio-value-vs-effort - - Identify and order dependencies
prio-dependencies-first - - Apply Kano model for feature classification
prio-kano-model
- - 使用MoSCoW优先级划分方法
prio-moscow-method - - 应用RICE评分法以确保客观性
prio-rice-scoring - - 明确绘制价值与投入的对比图
prio-value-vs-effort - - 识别并按依赖关系排序
prio-dependencies-first - - 应用Kano模型进行功能分类
prio-kano-model
4. Acceptance Criteria (HIGH)
4. 验收标准(高)
- - Use Given-When-Then format
accept-given-when-then - - Write testable acceptance criteria
accept-testable-criteria - - Include edge cases in acceptance
accept-edge-cases - - Define clear definition of done
accept-definition-of-done - - Avoid over-specification
accept-avoid-over-specification
- - 使用Given-When-Then格式
accept-given-when-then - - 撰写可测试的验收标准
accept-testable-criteria - - 在验收标准中包含边缘情况
accept-edge-cases - - 明确定义“完成”的标准
accept-definition-of-done - - 避免过度规格化
accept-avoid-over-specification
5. Stakeholder Alignment (MEDIUM-HIGH)
5. 利益相关者对齐(中高)
- - Identify all stakeholders early
stake-identify-stakeholders - - Gather feedback early and often
stake-early-feedback - - Resolve conflicts explicitly
stake-conflict-resolution - - Establish communication cadence
stake-communication-plan - - Align on success metrics
stake-success-metrics
- - 尽早识别所有利益相关者
stake-identify-stakeholders - - 尽早且频繁地收集反馈
stake-early-feedback - - 明确解决冲突
stake-conflict-resolution - - 建立沟通节奏
stake-communication-plan - - 对齐成功指标
stake-success-metrics
6. Technical Specification (MEDIUM)
6. 技术规格说明(中)
- - Document system context and dependencies
tech-system-context - - Define API contracts before implementation
tech-api-contracts - - Specify data models and schema changes
tech-data-model - - Plan error handling and recovery
tech-error-handling - - Specify performance requirements
tech-performance-requirements - - Document security considerations
tech-security-considerations
- - 记录系统上下文与依赖关系
tech-system-context - - 在实现前定义API契约
tech-api-contracts - - 指定数据模型与 schema 变更
tech-data-model - - 规划错误处理与恢复机制
tech-error-handling - - 指定性能需求
tech-performance-requirements - - 记录安全考量
tech-security-considerations
7. Change Management (MEDIUM)
7. 变更管理(中)
- - Use formal change request process
change-formal-process - - Assess full impact before approval
change-impact-assessment - - Version all specification documents
change-version-tracking - - Implement scope freeze periods
change-scope-freeze - - Maintain deferred items log
change-defer-log
- - 使用正式的变更请求流程
change-formal-process - - 在批准前评估全面影响
change-impact-assessment - - 对所有规格说明文档进行版本跟踪
change-version-tracking - - 实施范围冻结期
change-scope-freeze - - 维护延期事项日志
change-defer-log
8. Documentation Standards (LOW)
8. 文档标准(低)
- - Maintain single source of truth
doc-single-source - - Use consistent document templates
doc-consistent-templates - - Document key decisions with context
doc-decision-records - - Keep documentation accessible
doc-accessible-format - - Define project terminology
doc-glossary-terms
- - 维护单一事实来源
doc-single-source - - 使用统一的文档模板
doc-consistent-templates - - 记录关键决策及其背景
doc-decision-records - - 确保文档易于访问
doc-accessible-format - - 定义项目术语
doc-glossary-terms