天度 AI 实战库浏览全部案例 ↗

重新设计后重写README文件

Devin 审查了重新设计的代码库,并通过 PR 提交了新的 README 文件,其中包含了准确的设置与 API 信息,但在设计理念与目的方面存在困难。

使用工具Devin
具体怎么做
经过重大重构后,作者将代码库及逐步指导的提示词交付给 Devin。Devin 扫描了代码,阅读了旧的 README 文件,并提出了标题大纲。随后它等待“确认,继续”指令。接着被指示忘记使用代码库,以新开发者的方式按照自身设置说明操作,并报告存在的问题。之后,它从 develop 分支创建了一个 PR。
做到了什么
README文件中的设置步骤准确,API 端点说明清晰,且包含从代码中推导出的示例。但难以解释设计理念及项目整体目标,而这些内容并未包含在代码库中。
上手要点
作者未提供具体时间节点,建议在代码旁附上内部文档或架构图,以弥补缺失的逻辑与目的说明。

你可以这样试

使用 Devin

我在 [代码仓库路径] 上的项目最近被重新架构了。请扫描代码,并重新编写 README 文件,其中需包含准确的设置步骤、配置信息及 API 细节,同时对照实际代码检查每个命令。请留下清晰的占位符,用于标注设计思路与项目目的,由我来填写。将修改提交到新分支,并在打开 PR 前展示 diff 内容给我看。