27 lines
1.1 KiB
Markdown
27 lines
1.1 KiB
Markdown
# LPT 文档项目规则
|
|
|
|
## 职责
|
|
|
|
- 维护 LPT 系统的概念定义和设计思路。
|
|
- 文档面向系统本身，而不是面向开发过程。
|
|
|
|
## 保留内容
|
|
|
|
- 系统概念：学习任务、学习会话、学习预期、知识碎片、学习报告、复习、思维导图、回忆对比等。
|
|
- 设计思路：为什么采用某个概念、概念之间如何协作、模块边界在哪里。
|
|
- 稳定的术语映射：例如“学习报告残片”与“知识碎片”的关系。
|
|
- 所有文档放在 `docs/` 下，`concepts/` 放概念，`design/` 放设计思路。
|
|
|
|
## 禁止内容
|
|
|
|
- 开发笔记、日志、个人感想、时间线。
|
|
- 系统中间态、废弃方案、历史迁移过程。
|
|
- 文件路径、代码片段、接口清单、环境配置、构建与部署信息。
|
|
- 性能指标、问题修复记录、交付记录。
|
|
|
|
## 更新流程
|
|
|
|
- 概念变更时先更新对应概念文档，再更新术语表和设计文档。
|
|
- 新增概念时按现有模板补充“定义、设计意图、相关概念、当前系统体现”。
|
|
- 修改后同步 meta 仓库 `docs/README.md` 的文档地图。
|