写项目文档用这Skill选结构

帮你写规范的代码文档和 README。

documentation-templates 是为常见项目文档提供结构起点的 Skill。它覆盖 README、接口说明、注释、变更记录和架构决策,让不同问题有自己的位置。

新使用者先要知道项目做什么、怎样开始;调用接口的人需要输入、输出和错误;后来维护者则需要知道为什么作某个决定。结构要跟读者任务走,不是每篇都塞全部章节。

模板中的许可证、端口或返回状态只是示例,必须回到实际项目核。接口字段和默认值不能凭名字猜,快速开始也需验证前提,不能照抄“几分钟跑起来”。

适合补文档或统一导航。本文未生成项目文档;清楚层级可以帮助检索,llms.txt 或图表不保证所有工具会读取,维护事实与去掉过期内容比把模板填满更重要。

分类:AI 与 Agent

来源仓库:sickn33/agentic-awesome-skills

适合用来做什么

  • 有哪些推荐的文档模板和结构指南?
  • 如何编写 AI 友好型的代码注释?

安装 documentation-templates

npx skills add https://www.iskills.cc/skills/sickn33/agentic-awesome-skills/documentation-templates/SKILL.md

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

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

查看 documentation-templates 的用途与原始说明

浏览全部 Skill 指南