Create State 插件就像一个面向软件项目的持久化技术笔记助手。它可以帮助 Codex 保存重要代码、架构选择、调试结论和项目约定,并在后续会话中重新检索这些内容。

普通对话结束后,关键背景容易散失。Create State 将值得长期保留的信息组织为项目记忆,使 Codex 在下一次继续开发时能够了解此前做过什么、为什么这样设计,以及哪些方案已经被验证或放弃。其公开定位是跨会话保存代码片段与架构决策。

一、Create State 能做什么

打开网易新闻 查看精彩图片

图 1:Create State 保存并复用项目知识的基本流程

1、保存重要代码片段

用户可以保存具有长期参考价值的函数、配置、接口示例和命令。

保存时还可以补充代码用途、依赖版本、适用模块和使用限制,避免以后只看到代码,却不知道它解决什么问题。

2、记录架构决策

项目开发中经常需要在数据库、框架、部署方式和模块结构之间作出选择。

Create State 可以记录最终决定、选择理由、备选方案和影响范围。这样,团队以后重新讨论同一问题时,可以先了解当时的约束和判断依据。

3、积累调试经验

修复复杂错误后,可以保存错误现象、根本原因、修复方法和验证结果。

当类似异常再次出现时,Codex 可以检索过去的排查记录,减少重复分析。公开资料也将调试洞察列为 Create State 可持久保存的项目知识。

4、恢复项目上下文

开始新的会话时,用户可以要求 Codex 查找指定项目、模块或技术主题的历史记录。

这些内容可以帮助重新建立上下文,例如当前架构、已完成工作、未解决问题和必须遵守的技术约定。

5、形成项目知识库

持续保存的代码、决策和经验可以逐步构成个人项目知识库

公开介绍将其描述为面向软件项目的持久记忆,并以个人知识图谱组织相关信息,使不同代码、决策和问题之间能够建立联系。

二、怎样把任务说清楚

使用 Create State 时,应说明项目、信息类型、保存原因和适用范围。

至少应提供以下信息:

1、项目名称:记录属于哪个项目或代码库。

2、信息类型:代码、架构决策、调试结论或开发约定。

3、核心内容:需要长期保留的具体信息。

4、背景原因:为什么采用当前方案。

5、适用范围:涉及哪些模块、版本或环境。

可以使用下面的模板:

请使用 Create State 保存以下项目知识。

项目名称:[名称]

记录类型:[代码 / 决策 / 调试经验 / 约定]

主题:[简短标题]

核心内容:[需要保存的信息]

选择原因:[为什么这样处理]

适用范围:[模块、版本或环境]

相关内容:[文件、接口或其他决策]

状态:[有效 / 待验证 / 已废弃]

保存后请返回:记录摘要、关键词、关联内容和以后适合检索它的场景。

三、场景示例

示例 1:保存代码模板

保存项目统一使用的 API 请求封装代码,并记录超时、重试和错误处理约定。

示例 2:记录架构选择

记录项目选择 PostgreSQL 而未采用其他数据库的原因,包括事务需求、团队经验和部署条件。

示例 3:保存故障结论

记录一次缓存失效问题的现象、根因、修复提交和验证步骤,便于以后排查类似问题。

示例 4:恢复开发进度

查询当前项目最近保存的决策、未完成事项和已知风险,生成继续开发所需的上下文摘要。

示例 5:更新失效记录

找到旧版认证方案的记录,将其标记为已废弃,并关联新的实现方式和迁移原因。

四、使用时要注意

1、只保存长期有用的信息

临时输出、一次性日志和容易从代码中直接看出的内容不必全部保存,否则会增加检索噪声。

2、同时记录原因

只保存“采用了什么”往往不够。架构决策还应记录约束、备选方案和取舍理由。

3、区分事实与计划

已经实施的方案、尚未验证的设想和未来任务应分别标记,避免后续把计划误认为当前事实。

4、及时更新失效内容

依赖版本、接口和架构会发生变化。旧记录不应直接删除,可以标记为已废弃,并关联替代方案。

5、不要保存敏感信息

代码记录中不应包含密码、私钥、访问令牌、真实客户数据和其他机密内容。必要时只保存变量名称和配置方法。

小结

Create State 插件可以让 Codex 跨会话保存代码、架构决策和调试经验,并在后续开发中恢复项目上下文。记录结论的同时保留原因、范围和状态,才能形成可靠且可复用的项目知识。

点赞有美意,赞赏是鼓励