文档协作规则
文档协作规则
Section titled “文档协作规则”这个目录下的内容由 AI 协助生成、修改和整理,用来沉淀 Matrix 项目的想法、需求和文档。
每个 Markdown 文档都必须在开头保留元信息区,并至少包含 name 和 description 两项。为了兼容当前 Starlight 文档系统,文档还应包含 title:
---title: 文档标题name: 文档名称description: 文档说明---讨论过程中,一旦某个想法已经明确或没有疑问,就应写入对应文件的对应章节。早期内容可以集中写在一个文件中;随着内容丰富,再按主题拆分到多个文件。
同一问题多次出现时,处理原则如下:
- 如果观点相同,不重复记录。
- 如果观点发生变化,更新原有内容并整理表述。
- 不在多个位置重复存储同一件事。
- 写入时应梳理语言,使表达清晰、明确、简洁。
文档应合理划分章节,使用清晰的 Markdown 结构记录项目观点、需求、原则和待讨论问题。
References 命名规则
Section titled “References 命名规则”references 目录用于存放 Matrix 项目引用、改写和抽象出的基础文档。
该目录下的文件名应使用小写英文单词,并用中划线连接,例如 identity-definition.md。
记录项目想法时,应采用类似 skill 或技术文档的口吻:
- 客观:避免情绪化、宣传式或文学化表达。
- 简练:去除重复和不必要的解释。
- 准确:保留概念边界、条件和限制。
- 完整:不遗漏已确认的观点、需求和约束。