给项目文档做一次整体保鲜
检查文档之间与代码实际是否一致,交付配套修订稿。参考依据与借鉴内容
- 保持文档与实际行为一致
参考用实际代码与可信来源核对文档、保留结构并验证修订;文档地图、跨文档一致性和单轮交付范围由本站补充。
请对当前项目的文档做一轮整体保鲜,找出文档之间以及文档与实际实现之间的不一致,交付能直接采用的修订内容。 先从根目录 README、文档索引和 docs 等现有目录建立文档地图,区分当前指南、专题说明、历史记录与自动生成内容。主动识别运行、配置、发布、排错等主要使用路径,不让我指定文件。沿这些路径关联阅读相关文档及必要的代码、配置和脚本定义,不以单篇文档为上限;历史材料只用于追溯,不把历史状态当作当前事实。 重点核对:不同文档对同一命令、配置、路径或流程的说法是否一致;说明是否与实际代码对应;操作步骤有没有缺少前提;入口是否遗漏重要指南;本地链接是否存在。以项目当前实现和可核实的一手来源为依据,不能凭文档更新时间或措辞较新就判定哪一份正确。外部链接打不开时标为未验证,不直接判为失效。不要执行安装、发布、数据变更或删除命令来核对说明。 优先完成会让人操作失败或理解错误的修订,将同一问题涉及的多份文档一起核对、一起给出一致的候选改法。每项附文件位置、原文、依据与影响,直接交付完整替换段落或可应用的补丁;短文档可给完整修订稿。不只列问题清单,也不做缺乏收益的全库润色。无法确认的事实保留并标注,不把待实现或待验收能力写成当前事实。 如果文档很多,先覆盖主要使用路径和相互冲突的文档,其余列入未检查范围;不要按固定篇数随意截断,也不要宣称已读完全部材料。完成一轮后复查修订之间是否一致、路径与命令是否有效,交付文档地图、已完成修订和未验证项,然后结束。 执行约定: 直接开始,不先给计划让我确认,也不要让我选文件或补填模板。只用当前项目、当前对话及我已提供的材料,不搜索其他项目或私人历史。缺少材料时完成有依据的部分,在结果中说明缺口;完全不适用就说明原因并结束,不虚构成果。 保留现有文件和未提交改动;候选内容在回复中完整给出,适合独立成文的成果可另存为不重名的新文件。不要安装依赖、修改环境、提交、推送或发布。遇到权限或访问限制,记录未完成项,不绕过限制。自查一次后交付并结束,不用“是否继续”收尾。