第一章 总则¶
第一条 制定依据 本章程依据《量潮科技基本章程》《量潮科技代码管理章程》制定，旨在规范量潮数据业务的技术写作文档标准，确保文档可读、可维护、可验收。
第二条 目的 为建立技术写作的统一规范，降低因文档缺失或混乱导致的沟通成本和返工成本，特制定本章程。
第三条 适用范围 本章程适用于量潮数据业务相关的所有技术文档编写活动，包括但不限于交付文档、数据目录、处理流水线说明、验收规则说明。
第四条 文档分类 技术文档按用途分为三类：
（一）用户文档——面向客户和业务人员，说明交付内容和验收方式； （二）数据蓝图——面向技术与业务双方，作为数据契约的桥梁； （三）开发者文档——面向开发团队，记录实现细节和技术决策。
第二章 用户文档¶
第五条 组成 用户文档应包含以下内容：
（一）交付数据清单——客户最终收到的数据资产列表； （二）数据目录——全流程涉及的所有数据，包括客户提供的原始数据和中间产物； （三）处理流水线——从原始数据到最终产出的完整处理流程； （四）验收规则——本项目涉及的验收标准和验收方式。
第六条 交付数据清单 交付数据清单应记录每项交付物的名称、格式、字段说明和行数。清单应在项目交付前经客户确认。
第七条 数据目录 数据目录应覆盖以下类型：
（一）客户提供的原始数据； （二）清洗或预处理后的中间数据； （三）最终交付的结构化数据。
数据目录中的每个条目应注明来源、用途和处理状态。
第八条 处理流水线 处理流水线应以流程图或步骤列表的形式呈现，说明每个处理环节的输入、输出和关键参数。
第九条 验收规则 验收规则应区分 AI 验收标准与人工验收标准，明确各项标准的具体判定方式。
第三章 开发者文档¶
第十条 组成 开发者文档应记录开发过程中产生但未在用户文档中体现的技术信息，包括但不限于：
（一）性能优化记录——遇到的问题、分析过程和最终方案； （二）架构决策——技术选型理由和放弃的方案； （三）已知限制——当前实现的边界和未解决的问题； （四）调试指南——常见问题的排查方法。
第四章 文档质量标准¶
第十一条 文档完整性 每份技术文档应独立可读，不依赖读者对项目的先验了解。
第十二条 一致性 同一项目内的文档应使用统一的术语和命名：
（一）同一概念全程使用相同名称； （二）数据集名称、字段名称、文件名称应在所有文档中保持一致。
第十三条 版本对应 技术文档应与对应项目的代码版本保持一致。文档更新应随代码变更同步进行，不得事后补写。
第五章 附则¶
第十四条 章程效力 本章程经公司治理机构审议通过，自发布之日起生效。
第十五条 解释权 本章程之解释，应遵循清晰优先之基本原则。各项条文不得被解释为阻碍合理的文档简化或降低写作效率。