跳到正文

Haonan S012 技术文档

从当前需求、代码和运行证据生成或审查 API、数据字典、集成指南、SOP 与发布说明;持续维护逐任务开发记录索引、项目知识关联、文档有效性和完整交接。

个人 Skill产品研发5 个文件浏览次数 0
开始使用

下载前阅读 SKILL.md 中的使用条件,并确认所用工具支持对应能力。

输入资料
交付文档读取以下适用依据。缺少某类证据时对应内容保持未知或未验证,继续完成有依据的章节;实际代码、设计目标与运行证据分别标注。 【源码与 API 路由】:必须让用户提供或允许你读取核心的 Backend Controller 代码或 API 路由文件(这是生成 Swagger 的唯一绝对真理)。 【SKILL05-2/1】数据 Schema:提取最终版的 Prisma/SQL Schema 以及异构知识库结构(用于生成数据字典)。 【S… 阅读本节完整说明
交付内容
交付文档读取以下适用依据。缺少某类证据时对应内容保持未知或未验证,继续完成有依据的章节;实际代码、设计目标与运行证据分别标注。 【源码与 API 路由】:必须让用户提供或允许你读取核心的 Backend Controller 代码或 API 路由文件(这是生成 Swagger 的唯一绝对真理)。 【SKILL05-2/1】数据 Schema:提取最终版的 Prisma/SQL Schema 以及异构知识库结构(用于生成数据字典)。 【S… 阅读本节完整说明
环境与依赖
交付文档读取以下适用依据。缺少某类证据时对应内容保持未知或未验证,继续完成有依据的章节;实际代码、设计目标与运行证据分别标注。 【源码与 API 路由】:必须让用户提供或允许你读取核心的 Backend Controller 代码或 API 路由文件(这是生成 Swagger 的唯一绝对真理)。 【SKILL05-2/1】数据 Schema:提取最终版的 Prisma/SQL Schema 以及异构知识库结构(用于生成数据字典)。 【S… 阅读本节完整说明
  1. 获取完整包,保留配套文件的目录结构。
  2. 按照原文准备所需工具、依赖与输入资料。
  3. 阅读对应使用步骤与输入输出说明,在自己的环境中验证结果。

使用提示摘自原文,配套文件保留来源版本;实际运行条件以各包说明为准。

正文

获取原文件

references/documentation-workflow.md

当前实现根据代码、配置、接口和运行证据描述;目标范围根据用户最新决定和批准需求描述。二者存在差距时保留未完成需求,不能根据代码当前能力改写用户目标。

唯一当前记录

多任务与跨会话工作引用 交付记录。README、计划、交接和验收报告引用同一需求、任务、验收及证据 ID,避免分别维护相互冲突的完成状态。

当前交接至少包含全部未完成项、阻塞和解除条件、最新用户约束及来源、已授权范围、当前改动、运行环境身份、证据有效性和下一可执行任务。不能只记录最近完成内容或一个建议下一步。

历史材料注明对应时间与版本;当前文档直接呈现当前事实。用户撤回内容后基于当前保留材料更新,不把已撤销方案继续写入发布说明。

文档生成

  1. 盘点需求、Schema/OpenAPI、源码、命令、配置、设计和真实测试结果,记录来源与版本。
  2. 按受众选择开发、运维、测试、安全、产品或外部使用说明;详细目录见 文档范围。
  3. 可执行规范派生机器文档;用户说明使用业务语言,内部实施细节只在影响用户决策时出现。
  4. API、状态、错误、角色和示例与当前实现一致;设计草案明确状态,缺少源码时不能描述为已经实现。
  5. 验证命令、链接、引用、路径、示例语法和对应权限,使用成熟格式工具。
  6. 发布说明依据实际变更及 发布状态,明确目标、版本、时间、产物和验证。
  7. 指标给出定义、来源、测量和适用范围;计划值、模板值和历史结果不得写为当前事实。

完成检查

文档创建、结构检查通过、内容审查和产品验收分别记录。调整文案不能关闭原始功能任务,修订交接不能把未完成承诺改成已完成。

输出实际文档路径、事实来源、检查结果、内容盲区及完整剩余项。默认不发布站点或发送外部消息;已有明确授权按目标执行。下一行动根据当前未完成状态生成,不重复要求已经完成且证据有效的步骤。

Haonan S012 技术文档 · 原理图

查看原图
Haonan S012 技术文档 原理图

CONTACT HAONAN

联系haonan

医疗 AI · 产品与独立开发

刘浩南

关注医疗 AI 从 demo 到真实落地,聚焦产品化、商业化与院内工作流效率提升。

12年医疗产研经验,大湾区头部医疗AI公司前产品总监,独立开发者

医疗 AI 产品化医疗 AI 商业化院内工作流效率
刘浩南的微信联系二维码
微信扫一扫,联系 haonan