edit | blame | history | raw

编码规范

创建人员:Codex
文件职责:记录 Project F 默认开发体系必须遵守的本地编码规范入口。
管理规范/模板:../../common/dev-doc/编码规范.md。
引用文件:目录导读.md;开发事项总纲.md;开发事项计划.md;开发执行日志.md;开发审计报告.md;开发问题记录.md;开发方案目录按重型事项创建。
记录方式:本地开发规范;默认只记录项目特化补充。

1. 基本口径

本工作区所有开发人员必须同时遵守 ../../common/dev-doc/编码规范.md 和本文件。

本文件当前没有额外补充规则。如后续设计本地开发流程,必须满足 common 编码规范硬约束;流程通过审核后,执行时以本地流程为准。

2. 核心开发文档作用

文档 作用
目录导读.md 说明开发目录结构、代码入口、测试入口、当前事项和审计入口
编码规范.md 记录本地编码规范和 common 规范引用
开发审计规范.md 记录本地开发审计规范和 common 审计规范引用
开发事项总纲.md 记录开发事项背景、目标、边界、状态和结论
开发事项计划.md 记录开发计划、步骤、输入输出、验收方式和审计入口
开发方案/ 按重型开发事项创建具体编码方案文件;轻量开发不创建
开发执行日志.md 记录编码、测试、自检、中间结果、异常和偏离
开发审计报告.md 记录方案审核、实现审核、测试验收和复审结论
开发问题记录.md 记录非审计来源开发问题;审计问题只做跨轮索引