项目说明写给谁?看这Skill

编写或改进项目的README文档。

crafting-effective-readmes 是一份帮助 AI 按读者需求写项目说明的 Skill。同样叫 README,开源用户、同事与几个月后的自己,急着找到的内容往往不同。

先分清新写、补章节、更新还是审核;新项目先写解决什么问题与最快怎样跑起来,旧说明则对照实际文件和配置查过期内容。至少交代名称、用途原因和使用方法,新增内容放到读者需要的位置。

主文列开源、个人、内部项目与配置目录四种方向,具体模板和写法细则另外提供。本文没有展开未读取的模板,也不把所有 README 都写成开源招募页。把受众和当前项目状态一起提供,才能判断缺的是安装步骤、维护方法,还是“这份配置为什么存在”的背景。

分类:编程开发

来源仓库:softaworks/agent-toolkit

适合用来做什么

  • 帮我为我的开源项目编写一个简洁且吸引人的README文件。
  • 你能提供一个适合初学者的README模板吗?

安装 crafting-effective-readmes

npx skills add https://www.iskills.cc/skills/softaworks/agent-toolkit/crafting-effective-readmes/SKILL.md

在本机终端执行安装命令。安装前请阅读原始说明,确认所需工具、账号和权限。

查看安装步骤 · 查看常见问题

查看 crafting-effective-readmes 的用途与原始说明

浏览全部 Skill 指南