Back to Details

031-architecture-adr-functional-requirements

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Create ADRs for Functional Requirements (CLI and/or REST API)

为功能需求创建ADRs（CLI和/或REST API）

Guide stakeholders through a structured conversation to uncover and document technical decisions and functional requirements for command-line tools, REST/HTTP APIs, or combined surfaces. This is an interactive SKILL. The ADR is the documentation of that conversation, not the conversation itself. Infer CLI vs API from project context when possible; ask a short clarifying question when unclear.
What is covered in this Skill?
  • Surface discovery: CLI, REST/HTTP API, or both (inference + confirmation)
  • Initial context: purpose, users/consumers, constraints, timeline, load (API when relevant)
  • Functional requirements: surface-specific workflows, I/O, resources, errors
  • Technical decisions: language/framework; REST blocks (API design, auth, data, infra, testing/monitoring) and/or CLI blocks (architecture, data/integration, testing/distribution)
  • Decision synthesis and validation before ADR creation
  • ADR document generation and next steps
引导相关人员通过结构化对话，挖掘并记录命令行工具、REST/HTTP API或混合界面的技术决策与功能需求。这是一个交互式SKILL。ADR是对话内容的文档记录，而非对话本身。若可能，从项目上下文推断是CLI还是API；若不明确，可提出简短的澄清问题。
本Skill涵盖哪些内容？
  • 界面类型探索：CLI、REST/HTTP API或两者兼具（推断+确认）
  • 初始上下文：用途、用户/消费者、约束条件、时间线、负载（适用于API场景）
  • 功能需求：界面特定的工作流、输入输出、资源、错误处理
  • 技术决策：语言/框架；REST相关模块（API设计、认证、数据、基础设施、测试/监控）和/或CLI相关模块（架构、数据/集成、测试/分发）
  • ADR创建前的决策整合与验证
  • ADR文档生成及后续步骤

Constraints

约束条件

Use conversational discovery—ask 1-2 questions at a time, build on answers, validate before proceeding. Only create ADR after thorough conversation and user confirmation.
  • MANDATORY: Run 
    date
    before starting to get accurate timestamps for the ADR
  • MUST: Read the reference template fresh—do not use cached questions
  • MUST: Ask one or two questions at a time; never all at once
  • MUST: Validate summary with user ("Does this accurately capture your requirements?") before proposing ADR creation
  • MUST: Wait for user to confirm "proceed" before generating the ADR
采用对话式探索方式——每次提出1-2个问题，基于回答逐步推进，在继续前进行验证。仅在充分对话并获得用户确认后，方可创建ADR。
  • 强制要求：开始前运行
    date
    命令，为ADR获取准确时间戳
  • 必须：重新阅读参考模板——不得使用缓存的问题
  • 必须：每次仅提出1-2个问题；不得一次性全部提出
  • 必须：在提议创建ADR前，与用户验证摘要内容（“这是否准确涵盖了您的需求？”）
  • 必须：等待用户确认“继续”后，再生成ADR

When to use this skill

何时使用本Skill

  • Create ADR for functional requirements
  • Document functional requirements
  • Capture functional requirements
  • Generate functional requirements in an ADR
  • 为功能需求创建ADR
  • 记录功能需求
  • 捕获功能需求
  • 在ADR中生成功能需求

Reference

参考资料

For detailed guidance, examples, and constraints, see references/031-architecture-adr-functional-requirements.md.
如需详细指导、示例和约束条件，请参阅references/031-architecture-adr-functional-requirements.md。