规格

工程开发 社区

技能解读

当前原文的自动摘译,尚未人工审校。

决策日志

每个不明显的选择都会被记录下来。这可以防止以后重新对决策提出诉讼,并帮助未来的工程师理解事情为什么会是这样。对决策进行编号(D-1、D-2),以便可以在代码注释和 PR 描述中引用它们。

质量检查

在交付规范之前,请验证:它是否回答了“如何”而没有规定不必要的“到底是什么”?规范应该限制架构,而不是对实现进行微观管理。工程师需要空间来做出本地决策。边缘情况是否被覆盖?如果您只描述快乐路径,则实现将只处理快乐路径。数据模型是否完整?这里缺少字段或关系意味着稍后迁移。

范围边界

技术规范不是:教程。不要解释框架如何工作。假设具有工程能力。一个珠三角。不要重新定义我们正在构建的东西。参考 PRD 并重点关注如何实现。一个项目计划。不要包括时间表或任务分配。那是一个单独的工件。

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
工程开发
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
94 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@kazdenc · MIT
上下文用量评级
低消耗
接入复杂程度
需简单配置
是否需要外部接口密钥
不需要
兼容的系统
未声明(默认跨平台)
运行环境要求
未检出明确要求
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
  • 命令执行
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
第 1 步:阅读要求

在写作之前,收集输入。没有要求的规范只是猜测。来源 · 从中提取什么 PRD · 问题、目标、功能需求、非功能需求、范围边界 工作故事 · 用户工作流程、验收标准、边缘案例 对话 · 如果两者都不存在,则采访用户以确定系统必须做什么以及为谁做

02
第 2 步:编写规格

使用这个结构。根据项目调整标题——并非每个部分每次都适用。

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。