Haonan S012 技术文档

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

个人 Skill产品研发5 个文件浏览次数 0

获取完整包获取 SKILL.md

开始使用

下载前阅读 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… 阅读本节完整说明

获取完整包，保留配套文件的目录结构。
按照原文准备所需工具、依赖与输入资料。
阅读对应使用步骤与输入输出说明，在自己的环境中验证结果。

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

正文

获取原文件

references/document-bundle.md

资产索引

doc_id,audience,path,purpose,source_of_truth,version_or_commit,generation,owner,status,last_verified

开发者文档

每项 S008 任务的独立 Markdown 开发记录、唯一索引条目与有效性信息，见开发记录规则。
业务概念、接口实体、架构及开发记录的检索关系，见项目知识维护。
README/快速开始、环境与命令。
架构上下文、ADR 和模块边界。
OpenAPI/事件/Schema、认证、错误、配额和示例。
数据字典、迁移、兼容和本地开发数据。
扩展、贡献、测试和调试。

运维文档

环境矩阵、配置和秘密来源。
部署、迁移、备份、恢复、回滚和 smoke test。
指标、日志、追踪、告警、SLO 和值班。
Runbook：症状、确认、缓解、恢复、升级和事后动作。

产品与外部文档

角色、功能、限制、数据处理和管理员 SOP。
外部 API/SDK/Webhook 集成和版本策略。
FAQ、故障排查、培训与可访问性说明。
Release Notes、Breaking Changes、迁移步骤和废弃时间线。

自动校验

Markdown lint、链接和锚点。
OpenAPI/JSON Schema/YAML 语法。
代码片段与命令 smoke test。
路由/API/Schema 与文档的漂移检查。
敏感信息、真实个人数据和过时版本扫描。

校验结果记录工具、版本、命令、退出码和产物路径。

当前交付记录

引用同一需求、任务、验收与证据 ID，交接保留全部未完成项、约束来源、授权、当前修改、实际环境、有效证据和下一可执行任务。当前实现与目标范围分别描述，文案调整不能关闭尚未实现的业务需求。