spec-template
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseProduct Spec Template
产品规格模板
A structured 9-section template for defining software product specifications.
用于定义软件产品规格的结构化9节模板。
When to Use
适用场景
- Starting a new project from a one-liner idea
- Converting rough notes into a formal specification
- Reviewing spec completeness before implementation
- Ensuring consistent spec format across projects
- 从一句话想法启动新项目
- 将粗略笔记转化为正式规格文档
- 实施前评审规格的完整性
- 确保跨项目的规格格式一致
The 9 Sections
9个核心部分
Section Structure
部分结构
Every spec.md should include these sections:
markdown
undefined每个spec.md都应包含以下部分：
markdown
undefined🎯 [Product Name]
🎯 [Product Name]
🧠 One-Line Definition
🧠 One-Line Definition
[Concise description: what it is, key differentiator, core value prop]
[简洁描述：产品定位、核心差异化点、核心价值主张]
Top Principles
核心原则
- [Guiding principle 1]
- [Guiding principle 2]
- [Guiding principle 3]
- [指导原则1]
- [指导原则2]
- [指导原则3]
1. [Core Capability Area]
1. [核心能力领域]
| Category | Feature |
|---|---|
| ... | ... |
| 分类 | 功能 |
|---|---|
| ... | ... |
2. [Controls / Interactions]
2. [控制与交互]
| Feature | Support |
|---|---|
| ... | ... |
| 功能 | 支持情况 |
|---|---|
| ... | ... |
3. [Technical / Output Format]
3. [技术与输出格式]
| Feature | Support |
|---|---|
| ... | ... |
| 功能 | 支持情况 |
|---|---|
| ... | ... |
4. [Secondary Feature Area]
4. [次要功能领域]
| Feature | Support |
|---|---|
| ... | ... |
| 功能 | 支持情况 |
|---|---|
| ... | ... |
5. [Tertiary Feature Area]
5. [三级功能领域]
| Feature | Support |
|---|---|
| ... | ... |
| 功能 | 支持情况 |
|---|---|
| ... | ... |
6. [Optional Feature Area]
6. [可选功能领域]
| Feature | Support |
|---|---|
| ... | ... |
| 功能 | 支持情况 |
|---|---|
| ... | ... |
7. UI / UX Principles
7. UI/UX 原则
| Principle | Description |
|---|---|
| ... | ... |
| 原则 | 描述 |
|---|---|
| ... | ... |
8. Platform / Scope
8. 平台与范围
| Platform | Priority |
|---|---|
| ... | ... |
| 平台 | 优先级 |
|---|---|
| ... | ... |
9. Explicit Non-Goals
9. 明确的非目标
| Feature | Status |
|---|---|
| [Feature X] | ❌ |
| [Feature Y] | ❌ |
undefined| 功能 | 状态 |
|---|---|
| [功能X] | ❌ |
| [功能Y] | ❌ |
undefinedSection Guidelines
各部分编写指南
One-Line Definition
一句话定义
- Must be a single sentence
- Include: what it is, how it differs, core value
- Example: "A lightweight screen recorder that matches GNOME Screencast's minimal UX, adds audio capture, and supports basic post-capture annotation."
- 必须是完整的单句
- 需包含：产品定位、差异化点、核心价值
- 示例：“一款轻量级屏幕录制工具，匹配GNOME Screencast的极简UX，新增音频捕获功能，并支持基础的捕获后标注。”
Top Principles
核心原则
- 3-5 guiding principles
- Drive prioritization decisions
- Examples: "Quickly deliverable MVP", "Cross-platform support", "Minimal UI"
- 3-5条指导原则
- 用于驱动优先级决策
- 示例：“快速交付MVP”、“跨平台支持”、“极简UI”
Feature Sections (1-6)
功能部分（1-6节）
- Use tables for consistency
- Mark support: ✅ (yes), ❌ (no), Optional, Basic
- Group related features
- Section names vary by product type
- 使用表格确保格式一致
- 标记支持状态：✅（是）、❌（否）、可选、基础支持
- 按相关性分组功能
- 部分名称可根据产品类型调整
UI/UX Principles
UI/UX 原则
- Reference existing UX patterns when applicable
- Define the "feel" of the product
- Include mode-based behavior if relevant
- 适用时参考现有UX模式
- 定义产品的“体验质感”
- 若相关，需包含基于模式的行为说明
Platform Scope
平台范围
- List all target platforms
- Mark priority: Primary, Supported, Future
- Be explicit about what's NOT supported initially
- 列出所有目标平台
- 标记优先级：核心支持、兼容支持、未来规划
- 明确说明初始阶段不支持的平台
Non-Goals
非目标
- Critical section—prevents scope creep
- List features explicitly excluded
- Mark all with ❌
- Include common requests that won't be built
- 关键部分——防止范围蔓延
- 明确列出排除的功能
- 所有排除功能标记为❌
- 包含常见但不会开发的需求
Output Quality Checklist
输出质量检查清单
- One-liner is truly one sentence
- Principles are actionable, not vague
- Feature tables use consistent format
- Non-goals section is substantive (5+ items)
- No ambiguous "maybe" features—decide yes/no
- Platform priorities are clear
- 一句话定义确实是单句
- 原则具备可操作性，而非模糊表述
- 功能表格格式一致
- 非目标部分内容充实（5项以上）
- 无模糊的“可能”功能——明确是/否
- 平台优先级清晰