Roadmap 编写指南
核心原则:roadmap 是导航图,不是教科书。信息密度 > 详细程度。
When to use
必须应用此规范的场景:
- 向
docs/roadmap.md添加新版本/功能 - 更新已有版本的状态
- 记录架构决策的理由
- 标记禁止事项和数据源限制
1. 简洁性原则(CRITICAL)
❌ 禁止冗余
删除这些内容:
-
示例代码(除非必需理解问题)
❌ 错误: **实现方案:** ```python # 20 行完整代码示例 async def chat_with_loop(self, query: str) -> str: for i in range(15): ...✅ 正确: 实现方案:
chat_with_loop()方法,最多 15 轮 ReAct 循环 -
重复信息(已在其他文档详述)
[Description truncada. Veja o README completo no GitHub.]