《Git工作流与开源工程》编校体例表

版本：0.10

适用范围：教材大纲、前言、教材使用指南、18章正文、3个附录和参考文献

稿件状态：出版编校修订稿

一、语体

  1. 正文采用浅白、庄重的教材语体，以陈述句为主。
  2. 单句一般不超过45字。每段聚焦一个意思，一般由3—6句组成。
  3. 不使用口语、网络语、营销语和情绪化过渡。
  4. 允许使用“我们”和“你”，不使用带有随意色彩的群体称呼。
  5. 比喻只用于帮助理解，并须回到可验证的技术机制。

二、结构

  1. 正文层级不超过三级，即章、节和小节。
  2. 章内二级标题采用“章号．节号”的连续编号。
  3. 需要继续分层时，使用无编号小标题或分段说明。
  4. 每章围绕一个主要工程问题展开，结尾设置本章小结和综合实践。
  5. 第1—12章采用教师贯穿项目，第13—18章采用学生原创项目。

三、术语

统一用语 不采用的异名或旧称 说明
AI开发智能体 编程助手、代码助手 指能够读取工程并调用开发工具的AI软件
议题 Issue、任务单 首次出现写“议题（Issue）”
合并请求 MR、拉取请求 首次出现写“合并请求（Merge Request，MR）”
技术决策记录 架构决策记录 缩略语为ADR
构建物 产物、制品 指可验证或发布的工程文件
构建物清单 Manifest 数据集清单、模型清单按对象分别命名
基准输入输出 Golden样例、Golden文件 用于核对不同运行环境的数值接口
JSON模式 Schema 指机器可检查的数据结构规则
散列值 哈希值、校验值 文件身份核对使用“散列值”
闪存 Flash 指保存固件、模型和静态资源的非易失存储
发布版本 Release 指经过版本固定和发布审查的构建物集合

同一概念全书使用同一名称。代码、命令、字段和软件界面中的原始英文名称保持不变。

四、中英文与代码

  1. 英文缩略语首次出现时，采用“中文全称（英文全称，缩略语）”。
  2. 首次注释后，正文只使用中文名称或缩略语。
  3. 软件名采用官方写法，如Visual Studio Code、Cline、Qwen和GitLab。
  4. 命令、文件名、路径、参数、模型名和版本号使用行内反引号。
  5. 代码块中的关键字、字段和文件路径保持工程原样，不按正文术语改写。

五、数字、标点和单位

  1. 计量、统计、编号和日期使用阿拉伯数字。
  2. 概数、习惯语和成语使用汉字。
  3. 正文使用中文全角标点。范围号使用“—”，省略号使用“……”。
  4. 数值与单位之间留一个空格，如20 ms、256 MB。
  5. 标准号、版本号、命令参数和代码中的连字符保持原样。

六、内容边界

  1. 本书重点讲解AI协同、Git工作流、工程质量、进度控制和开源发布。
  2. 模型训练与数据分析的深入内容由《人工智能数据科学》承担。
  3. 器件、电路、驱动和嵌入式实现的深入内容由《感知与异构计算系统原型》承担。
  4. 本书只讲正确集成、验证和评审所需的算法与硬件知识。
  5. 校内服务地址、密钥、板卡参数和软件界面变化由课程环境卡维护。

七、任务与证据

  1. 综合实践必须要求学生形成自己的工程成果。
  2. 任务成果可以是调研记录、技术决策、代码、测试、版本或发布材料。
  3. 不设置只要求“运行并观察”的封闭式练习。
  4. 每项工程结论须给出可核查依据，如提交、差异、日志、实测或评审记录。
  5. 自动测试、实机测试和用户验收各有证明范围，不得相互替代。

八、编校依据