文档写作规范

本项目所有文档最终在 Rspress 站点上渲染给人阅读,AI 智能体产出内容时同样遵守这份规范。AGENTS.md 只保留一句话级别的提醒,细则以本文为准。

一、数据时效

编写能获取实际数据的内容(如宏观经济指标)时,即时获取最新数据,标注数据时间,作为当前最新决策参考。引用旧数据时写明时点,不冒充最新。

二、内容组织

  • 所有内容围绕趋势定投之路这个主题展开:路径要有可行性,前后递进,能最终走到趋势定投之路的终点
  • Markdown 中不要使用 --- 分割线。Rspress 渲染时会在一级标题(H1)后自动添加分割线,手动写入会造成重复分割线,影响页面美观;章节之间的视觉分隔由 Rspress 主题自动处理,无需手动添加

三、去除 LLM 生成痕迹

文档内容须保持自然、利于阅读的写作风格,避免以下模式:

  • 文档头元数据:**最后更新**:xxx、**最后更新时间**:xxx、**用途**:xxx、**建议频率**:xxx、**建议周投入**:xxx、**总投入**:xxx、**建议总投入**:xxx、**时间窗口**:xxx 等
  • 生硬衔接标题:## 相关文档、## 配套文档、## 下一阶段衔接、## 学习目标、## X、与项目其他文档的关联、## X、配套文档链接 等,统一改为 ## 延伸阅读
  • 模块化标题:## 模块一:xxx 改为 ## 一、xxx;### Q1:xxx 改为 ### xxx;### 阶段交付物、### 阶段自检、### 月度产出物 改为 ### 交付清单、### 自检、### 月度产出
  • 生硬口吻:本文档 改为 本文;本课程 改为 本路径;完成本阶段后,进入 改为 走完这一段,进入;本阶段建立的 改为 这里建立的
  • 强调标签滥用:blockquote 中的 > **核心原则**:、> **本阶段目标**:、> **背景**:、> **说明**: 等去掉强调符号(保留内容);正文中的 **示例答案**:、**训练方法**:、**A**: 等去掉强调
  • 学习目标段:避免 ## 学习目标 + 完成本阶段后,你应该能够: + 编号列表 这种标准开头;避免 > 本阶段目标:xxx 这类目标声明行
  • LLM 式总结:避免"本文档旨在..."、"本文将..."、"通过本文..."等套路化总结句

四、合理保留的业务术语

以下术语不视为 LLM 痕迹,按业务语义正常使用:数据库 schema 中的 最后更新时间 字段注释、时间窗口(描述时间区间)、总投入(描述时间预算)、本节/本阶段/本章(指代学习路径中的章节)、学习路标(文档类型名称)等。