Skip to content

文档规范

这些规范保持 Emotile 文档简洁、一致,并与 AGENTS.md 对齐。

文档 vs Issue

  • 长期规划属于 docs/,而非无限期开放的 issue。
  • 开放的 issue应默认为 Builder 可执行的任务或短期可操作的工作。
  • 规划 issue必须在决策做出后关闭,结论迁移到文档。

双语文档

  • 中英文文档应保持大致一致的结构。
  • 不要在文档中重复大段源代码。
  • 每种语言应自成一体。

决策记录

每个决策记录应包含:

  • 决策——决定了什么
  • 背景——为什么需要这个决策
  • 后果——决策带来什么
  • 延期替代方案——有意推迟了什么

避免什么

  • 不要把路线图变成无限愿望清单。
  • 不要创建企业级流程文档。
  • 不要在文档中重复 AGENTS.md 内容。
  • 不要添加与 actual code 脱节的大段源代码。

审查清单

  • Builder 文档更改:检查 README、规范和 AGENTS.md 是否需要同步更新。
  • Architect 审查文档 PR:检查是否与项目原则冲突。
  • 保持文档轻量,避免企业流程语气。

Released under the MIT License.