38 lines
2.4 KiB
Markdown
38 lines
2.4 KiB
Markdown
# 文档目录说明
|
|
|
|
本目录是 SystemSimulationApp 更新日志、现行标准和其他技术报告的统一入口。
|
|
|
|
## 目录职责
|
|
|
|
| 目录 | 职责 |
|
|
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
| [`update-log/`](update-log/) | 按日期保存每日更新日志，记录当天已经完成的上传、修改及其影响。 |
|
|
| [`standard/`](standard/) | 保存当前采用的标准、协议和开发规范。实现、评审和 AI 修改代码时，应优先以这里的文档为准。 |
|
|
| [`other/`](other/) | 保存不属于现行标准的其他文档，例如性能仿真报告、优化报告、调研记录和技术总结。这些文档主要用于分析和参考，不默认作为强制规范。 |
|
|
|
|
新增或移动文档时，应根据文档用途放入对应目录。目录链接可用于查看其中的全部文档，无需在本文件中逐项维护清单。
|
|
|
|
## `update-log` 书写规范
|
|
|
|
以下规范适用于新建和后续追加的日志。历史日志缺少准确完成时间时，不猜测或补写时间。
|
|
|
|
1. 按日期填写日志。每个文件只记录一天的更新，文件名使用 `更新日志-YYYY-MM-DD.md`，标题使用 `# 更新日志 YYYY-MM-DD`。
|
|
2. 同一天内有多次上传或更新时，按各项工作的实际完成时间分段记录。每段使用北京时间、24 小时制的 `## HH:mm` 标注时间，并按完成时间从早到晚排列。
|
|
3. 不同时间完成的内容应分别记录，不要合并到同一时间段。一次上传或更新包含多项相关修改时，可以写在同一时间段内。
|
|
4. 语言应简短且信息充分，让 AI 和人都能快速理解。优先说明完成了什么、结果是什么、影响哪些范围，删除重复描述和无关过程。
|
|
5. 尽量使用通俗易懂的语言，减少难以理解的术语。必须使用专业术语时，应提供必要的简短说明。
|
|
|
|
推荐格式：
|
|
|
|
```markdown
|
|
# 更新日志 YYYY-MM-DD
|
|
|
|
## HH:mm
|
|
|
|
- 完成的修改、结果及影响范围。
|
|
|
|
## HH:mm
|
|
|
|
- 完成的修改、结果及影响范围。
|
|
```
|