互联网行业技术部工程师技术文档编写手册.docxVIP

互联网行业技术部工程师技术文档编写手册

第1章文档编写规范与元数据管理

1.1基础文档元数据定义与格式标准

文档元数据是记录文档生命周期的核心信息，必须包含文档标题、文档编号（如DOC001）、创建人、创建时间、最后修订人、最后修订时间、文档状态（草稿/评审中/已发布/废弃）、文档类型（API参考/内部Wiki/技术白皮书）以及关键字段。②所有字段必须使用ISO8601标准时间格式（YYYY-MM-DDHH:mm:ss），禁止使用“今天”、“昨天”等相对时间，以确保系统自动归档的准确性。文档编号采用“项目-年份-序号”结构，例如APP-2023-001，需确保同一项目内同一类型文档的编号连续且无冲突，避免重复引用。④文档类型需严格映射至内部分类体系，如“接口文档”对应代码库中的“接口定义”标签，“架构文档”对应“系统架构”标签，以便搜索引擎准确抓取相关资源。⑤元数据字段必须与代码仓库中的GitCommitMessage规范保持一致，例如CommitMessage中的“feat:新增用户登录接口”必须对应文档中的“用户登录API接口说明”。禁止在元数据中填写任何包含“绝密”、“机密”、“内部”等敏感修饰词，所有文档默认按“公开”或“内部共享”处理，敏感信息仅在发布流程中经过脱敏处理。

1.2版本控制策