| name | doc-readme |
| description | 当用户需要写README时使用;当需要满足用户对readme文档的要求时使用 |
doc-readme
作用
限定如何写README,
如果项目已经有了, 审查README是否符合以下规范, 先列出建议变更项, 标上序号, 再询问用户是否做出变更
如果项目没有或者README非常不完善, 先审查项目总体, 然后帮用户完善README, 并询问用户是否还要哪些更新
Tips
不要尝试每次重新阅读所有代码, 先阅读当前README, 然后检查上次更新节点, 应该寻找明显大幅更新的提交节点, 以这个为锚点, 开始往后找所有功能相关的提交, 然后重点阅读相关的文件, 提炼变更, 如果有已经有CHANGELOG相关文件,那就优先查看CHANGELOG
规则
- README 应该简洁明了,易于理解
- 默认放在项目根目录下
- 如果当前有
waza-writeskill, 阅读书写规范
- 有
功能块, 列出最核心功能和简单brief, 禁止长篇大论和大量小功能点
- 有
快速上手块, 引导用户快速上手; 快速上手应该分步骤引导, 每个步骤应该有清晰的描述, 站在用户视角进行项目探索, 书写前, 必须先模拟用户使用顺序, 自己在隔离环境或者目录下进行; 如果项目面向用户也面向开发, 那么不要在快速上手中体现大量开发内容与代码; 除非用户明确要变更, 否则不进行重写
- 有展示核心配置示例, 和配置的表格(描述默认值和作用)
- 如果项目有
docs/user-guide/, 链接并在文档指引
- 有
贡献块, 引导用户如何贡献
- 有
许可证块, 说明项目的许可证