en un clic
doc-readme
当用户需要写README时使用;当需要满足用户对readme文档的要求时使用
Installer avec Codex ou Claude Copiez ce prompt, collez-le dans Codex, Claude ou un autre assistant, puis laissez-le vérifier la page du skill et l'installer pour vous.
Menu
当用户需要写README时使用;当需要满足用户对readme文档的要求时使用
Installer avec Codex ou Claude Copiez ce prompt, collez-le dans Codex, Claude ou un autre assistant, puis laissez-le vérifier la page du skill et l'installer pour vous.
Basé sur la classification professionnelle SOC
编写、修改、审查或建议更新 AGENTS.md 时使用
编写、修改项目文档,或需要统一文档约定时使用
Git 提交、GitHub 日常操作或提交前文档检查时使用
管理项目长期知识,支持 recall、capture、mine、audit 四种模式。用于搜索 Pi 当前或历史 Session、回忆过去决策、从开发过程提炼可复用经验、更新 AGENTS 或项目 Skill、形成 ADR/Postmortem 候选,以及检查项目知识是否过时、重复、冲突或放错位置。跨 Session 检索依赖本机安装的 project-memory CLI(Bun/TS)
发起、审查或规划子代理工作时使用
当用户需要写用户指南时使用;当需要满足用户对用户指南的要求时使用
| name | doc-readme |
| description | 当用户需要写README时使用;当需要满足用户对readme文档的要求时使用 |
限定如何写README, 如果项目已经有了, 审查README是否符合以下规范, 先列出建议变更项, 标上序号, 再询问用户是否做出变更 如果项目没有或者README非常不完善, 先审查项目总体, 然后帮用户完善README, 并询问用户是否还要哪些更新
不要尝试每次重新阅读所有代码, 先阅读当前README, 然后检查上次更新节点, 应该寻找明显大幅更新的提交节点, 以这个为锚点, 开始往后找所有功能相关的提交, 然后重点阅读相关的文件, 提炼变更, 如果有已经有CHANGELOG相关文件,那就优先查看CHANGELOG
waza-writeskill, 阅读书写规范功能块, 列出最核心功能和简单brief, 禁止长篇大论和大量小功能点快速上手块, 引导用户快速上手; 快速上手应该分步骤引导, 每个步骤应该有清晰的描述, 站在用户视角进行项目探索, 书写前, 必须先模拟用户使用顺序, 自己在隔离环境或者目录下进行; 如果项目面向用户也面向开发, 那么不要在快速上手中体现大量开发内容与代码; 除非用户明确要变更, 否则不进行重写docs/user-guide/, 链接并在文档指引贡献块, 引导用户如何贡献许可证块, 说明项目的许可证