feature-spec

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Software 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

按优先级划分的规则类别

PriorityCategoryImpactPrefix
1Scope DefinitionCRITICAL
scope-
2Requirements ClarityCRITICAL
req-
3Prioritization FrameworksHIGH
prio-
4Acceptance CriteriaHIGH
accept-
5Stakeholder AlignmentMEDIUM-HIGH
stake-
6Technical SpecificationMEDIUM
tech-
7Change ManagementMEDIUM
change-
8Documentation StandardsLOW
doc-
优先级类别影响程度前缀
1范围定义关键
scope-
2需求清晰度关键
req-
3优先级框架
prio-
4验收标准
accept-
5利益相关者对齐中高
stake-
6技术规格说明
tech-
7变更管理
change-
8文档标准
doc-

Quick Reference

快速参考

1. Scope Definition (CRITICAL)

1. 范围定义(关键)

  • scope-define-boundaries
    - Define explicit scope boundaries
  • scope-document-assumptions
    - Document all assumptions explicitly
  • scope-work-breakdown
    - Break scope into measurable work items
  • scope-define-mvp
    - Define MVP before full feature set
  • scope-stakeholder-signoff
    - Get stakeholder signoff on scope
  • scope-define-boundaries
    - 明确界定范围边界
  • scope-document-assumptions
    - 明确记录所有假设条件
  • scope-work-breakdown
    - 将范围拆解为可衡量的工作项
  • scope-define-mvp
    - 在确定完整功能集之前先定义MVP
  • scope-stakeholder-signoff
    - 获取利益相关者对范围的签字确认

2. Requirements Clarity (CRITICAL)

2. 需求清晰度(关键)

  • req-specific-measurable
    - Write specific, measurable requirements
  • req-user-stories
    - Structure requirements as user stories
  • req-avoid-solution-language
    - Avoid solution-specific language
  • req-functional-nonfunctional
    - Separate functional and non-functional
  • req-consistent-terminology
    - Use consistent terminology
  • req-traceability
    - Maintain requirements traceability
  • req-specific-measurable
    - 撰写具体、可衡量的需求
  • req-user-stories
    - 以用户故事的形式构建需求
  • req-avoid-solution-language
    - 避免使用特定解决方案的语言
  • req-functional-nonfunctional
    - 区分功能性需求与非功能性需求
  • req-consistent-terminology
    - 使用统一的术语
  • req-traceability
    - 保持需求的可追溯性

3. Prioritization Frameworks (HIGH)

3. 优先级框架(高)

  • prio-moscow-method
    - Use MoSCoW prioritization method
  • prio-rice-scoring
    - Apply RICE scoring for objectivity
  • prio-value-vs-effort
    - Map value vs effort explicitly
  • prio-dependencies-first
    - Identify and order dependencies
  • prio-kano-model
    - Apply Kano model for feature classification
  • prio-moscow-method
    - 使用MoSCoW优先级划分方法
  • prio-rice-scoring
    - 应用RICE评分法以确保客观性
  • prio-value-vs-effort
    - 明确绘制价值与投入的对比图
  • prio-dependencies-first
    - 识别并按依赖关系排序
  • prio-kano-model
    - 应用Kano模型进行功能分类

4. Acceptance Criteria (HIGH)

4. 验收标准(高)

  • accept-given-when-then
    - Use Given-When-Then format
  • accept-testable-criteria
    - Write testable acceptance criteria
  • accept-edge-cases
    - Include edge cases in acceptance
  • accept-definition-of-done
    - Define clear definition of done
  • accept-avoid-over-specification
    - Avoid over-specification
  • accept-given-when-then
    - 使用Given-When-Then格式
  • accept-testable-criteria
    - 撰写可测试的验收标准
  • accept-edge-cases
    - 在验收标准中包含边缘情况
  • accept-definition-of-done
    - 明确定义“完成”的标准
  • accept-avoid-over-specification
    - 避免过度规格化

5. Stakeholder Alignment (MEDIUM-HIGH)

5. 利益相关者对齐(中高)

  • stake-identify-stakeholders
    - Identify all stakeholders early
  • stake-early-feedback
    - Gather feedback early and often
  • stake-conflict-resolution
    - Resolve conflicts explicitly
  • stake-communication-plan
    - Establish communication cadence
  • stake-success-metrics
    - Align on success metrics
  • stake-identify-stakeholders
    - 尽早识别所有利益相关者
  • stake-early-feedback
    - 尽早且频繁地收集反馈
  • stake-conflict-resolution
    - 明确解决冲突
  • stake-communication-plan
    - 建立沟通节奏
  • stake-success-metrics
    - 对齐成功指标

6. Technical Specification (MEDIUM)

6. 技术规格说明(中)

  • tech-system-context
    - Document system context and dependencies
  • tech-api-contracts
    - Define API contracts before implementation
  • tech-data-model
    - Specify data models and schema changes
  • tech-error-handling
    - Plan error handling and recovery
  • tech-performance-requirements
    - Specify performance requirements
  • tech-security-considerations
    - Document security considerations
  • tech-system-context
    - 记录系统上下文与依赖关系
  • tech-api-contracts
    - 在实现前定义API契约
  • tech-data-model
    - 指定数据模型与 schema 变更
  • tech-error-handling
    - 规划错误处理与恢复机制
  • tech-performance-requirements
    - 指定性能需求
  • tech-security-considerations
    - 记录安全考量

7. Change Management (MEDIUM)

7. 变更管理(中)

  • change-formal-process
    - Use formal change request process
  • change-impact-assessment
    - Assess full impact before approval
  • change-version-tracking
    - Version all specification documents
  • change-scope-freeze
    - Implement scope freeze periods
  • change-defer-log
    - Maintain deferred items log
  • change-formal-process
    - 使用正式的变更请求流程
  • change-impact-assessment
    - 在批准前评估全面影响
  • change-version-tracking
    - 对所有规格说明文档进行版本跟踪
  • change-scope-freeze
    - 实施范围冻结期
  • change-defer-log
    - 维护延期事项日志

8. Documentation Standards (LOW)

8. 文档标准(低)

  • doc-single-source
    - Maintain single source of truth
  • doc-consistent-templates
    - Use consistent document templates
  • doc-decision-records
    - Document key decisions with context
  • doc-accessible-format
    - Keep documentation accessible
  • doc-glossary-terms
    - Define project terminology
  • doc-single-source
    - 维护单一事实来源
  • doc-consistent-templates
    - 使用统一的文档模板
  • doc-decision-records
    - 记录关键决策及其背景
  • doc-accessible-format
    - 确保文档易于访问
  • doc-glossary-terms
    - 定义项目术语