场景:整理一份项目说明

一份不断补充的项目文档,常会出现标题重复、层级跳跃和主题分散。Index 不替你阅读内容,但可以把标题集中呈现,让结构问题更容易被发现。

提取结构

将 Markdown 原文粘贴到 Index。点击分析后,对照标题顺序与行号,检查是否存在突然跳跃的层级。代码示例中的 # 会被忽略,避免示例内容混入目录。

按读者的问题检查

  • 文档是否先说明解决什么问题,再解释怎样使用?
  • 安装前提、运行步骤与输出说明是否处于清楚的位置?
  • 同一层级的标题是否表达相近的内容范围?
  • 已知限制是否可以直接找到,而不是藏在末尾的一句话里?

修改原文并重新分析

在原始编辑器中调整标题,再把新版本放入工具重新分析。确认结构后导出索引,作为评审材料或项目说明的辅助目录。

工具只能提示层级变化,无法判断标题是否准确、内容是否完整;这些判断仍需要你结合文档用途完成。