Go Deh:发现技术文档中的缺陷
作者提出了一种利用人工智能进行文档测试的新方法。在更新项目的教程和 Markdown 格式文档后,作者考虑使用 AI 来检验其有效性。作者指示 ChatGPT 创建一个隔离的聊天环境,在该环境中读取文档并尝试使用所述工具。AI 表示同意,生成了新聊天的详细提示词,并监控其进展。随后,AI 反馈了其在文档中发现的缺陷。例如,它指出文档缺乏关于该工具预期在 Linux 环境下使用的明确声明,尽管提供了 Linux 和 WSL 的设置细节。这导致 AI 尝试在 Windows 环境中运行该工具,从而凸显了作者隐含的假设,需要进一步澄清。作者赞赏这种方法,即让 AI 扮演新用户,主动尝试完成任务并报告遇到的问题。这超越了单纯的措辞审查,提供了对文档可遵循性的实际测试。虽然 AI 可能会提出无效的观点,但人类判断在决定实施哪些更改方面仍然至关重要。作者强调,文档必须同时服务于人类读者和 AI 助手。随着越来越多的用户可能使用 AI 进行项目交互,文档需要清晰到足以供人类直接使用,并能让 AI 有效地辅助用户。这意味着需要考虑文档在支持 AI 交互方面的效果,而不仅仅是专门为 AI 撰写。最终,作者提出应像测试代码一样测试文档,即评估用户(无论是人类还是 AI)是否能够成功遵循文档以完成任务。这种创新的测试方法为提升未来项目中文档的有效性提供了新的视角。