01安装入门
交给 Agent 安装
复制下面的提示词给你的 Agent。它会先核对环境与冲突,再按仓库说明安装和验证。
请帮我安装 Neat Freak Codex Skill。开始前先检查当前 Codex 环境、所需依赖和是否已经存在同名 Skill;不要覆盖已有内容。阅读 duxinrui9-gif/neat-freak-codex-skill 仓库的 README、安装说明、原始来源和 MIT 许可证后,按仓库提供的方法安装 skills/neat-freak。完成后执行仓库提供的校验方式,并告诉我安装位置、校验结果,以及适合在什么阶段调用。遇到路径冲突、权限问题或来源无法确认时请停止并说明原因。
它解决什么问题
Neat Freak 面向项目收尾:把散落在实现、README、架构说明和 handoff 里的状态重新对齐,让下一个参与者能知道项目是否真的完成、怎样验证、哪里仍有风险。它不取代需求判断,也不替代安全审核。
先理解三个概念
| 概念 | 含义 |
|---|---|
| 收尾 | 在一个阶段结束时核对交付物、文档、验证和遗留项 |
| 交接 | 让未参与过项目的人能够安全接手 |
| 整洁 | 清楚区分正式交付物、临时产物和不应提交的内容 |
整洁并不等于删除得越多越好。来源不明、仍可能被使用或涉及用户资料的文件,都应该先说明风险并请求确认。
什么时候调用
适合在功能完成、准备交接、发布前、长期项目阶段切换,或发现文档与实际实现不一致时调用。不适合在任务刚开始、需求还模糊或需要快速探索时调用;先把方向和范围确定,再进入收尾。
安装前检查
阅读公开仓库的安装说明、许可与原始来源。确认 Codex 环境与依赖可用,也确认不存在需要保留的同名 Skill。遇到路径冲突、权限不足或来源无法确认时停止,不要通过覆盖已有目录来解决。
第一次使用:从轻量交接开始
选择一个非生产、范围清楚的项目,并告诉 Agent 只做检查和建议。可以这样描述:
请对当前项目做一次轻量收尾检查。
先阅读 README、AGENTS、架构说明和 handoff;
不要删除或重写任何文件。
列出文档与实现不一致处、未验证项、可能的临时产物,
并给出按风险排序的建议。
先观察结果是否尊重范围,再考虑让它协助更新文档。即使允许写入,也应将修改限制在明确的文件和当前任务相关内容。
两种常用场景
场景一:阶段交接
检查 README 是否能让新成员启动项目;检查 AGENTS 是否写清边界;检查架构说明是否反映现有结构;把本轮完成项、验证命令、未完成项和下一步写入 handoff。交接的目标是降低重新理解成本,不是堆砌历史细节。
场景二:准备发布
检查页面、配置和说明是否一致,确认构建和关键交互已验证。重点留意本机路径、内部链接、测试资料、未确认文案和隐私信息。发现风险时将其列为阻塞项,不要自动删除或发布。
如何判断收尾是否完成
- 当前交付物和用户目标相符。
- 关键验证已运行,或者未运行原因已明确记录。
- README、AGENTS、架构说明和 handoff 只更新了确实需要的部分。
- 没有把私人资料、环境配置或临时产物带进正式交付。
- 后续参与者能找到入口、边界、已知风险和下一步。
常见问题
它会自动清理文件吗?
不应当。删除、覆盖或移动文件之前需要明确授权和准确目标。默认先报告,再由人决定处理方式。
项目已有自己的收尾规范怎么办?
先读取并遵守现有规范。Neat Freak 的价值是补足检查和交接,不是把所有项目改成同一种文档结构。
如果工作区本来就很乱?
区分当前任务改动、已有改动和来源不明内容;只处理明确属于当前范围的部分。不能可靠区分时,应保留现场并说明,而不是为了干净强行整理。
来源与许可
Neat Freak 的原始方法由数字生命卡兹克发布;本资源为 Codex 适配与维护版本。公开仓库只包含可复用的说明和实现,不包含个人项目材料或环境配置,采用 MIT 许可证。