文档写作规范

本文是轻量规范，用于让文档保持一致，而不增加过多维护成本。

页面结构

功能页建议包含：

1. 这是什么。
2. 什么时候使用。
3. 前置条件。
4. 操作步骤。
5. 验证方式。
6. 常见故障。
7. 相关页面。

不是每页都必须完整包含这些小节，但新增页面应优先按这个顺序组织。

写作原则

• 先给可执行路径，再解释背景。
• 命令应可复制运行。
• 涉及生产环境时明确风险和回滚。
• 避免承诺投资收益或模型准确性。
• 不粘贴真实 API key、token、session、数据库连接串或私有频道信息。

术语

• 使用“研究团队”，不要混用“项目组”“策略组”。
• 使用“消息订阅”，不要把 Telegram 和 RSS 写成两个完全独立领域。
• 使用“投研会议”，不要简写成“会议”作为页面标题。
• 使用“模拟交易”，不要称为“实盘交易”。

图表

流程图使用 Mermaid：

```mermaid
flowchart TD
  start[开始] --> done[完成]
```

图表应服务于理解流程，不替代操作步骤。每张图后应有简短说明或验证要点。