·readme-writer
</>

readme-writer

gohypergiant/agent-skills

在任何项目或包中创建或编辑 README.md 文件时使用。递归地解析自述文件位置的代码库,根据缺失或更改的功能提出更改建议,并生成完整的、听起来人性化的文档,其中包含可复制粘贴的代码块和实际示例。

5安装·0热度·@gohypergiant

安装

$npx skills add https://github.com/gohypergiant/agent-skills --skill readme-writer

SKILL.md

This skill guides the creation and maintenance of comprehensive, human-friendly README documentation by analyzing the codebase and ensuring documentation stays in sync with actual functionality.

Identify where the README should live. In monorepos, this determines the scope of codebase analysis:

Use the README Template as a starting point for new READMEs.

在任何项目或包中创建或编辑 README.md 文件时使用。递归地解析自述文件位置的代码库,根据缺失或更改的功能提出更改建议,并生成完整的、听起来人性化的文档,其中包含可复制粘贴的代码块和实际示例。 来源:gohypergiant/agent-skills。

查看原文

可引用信息

为搜索与 AI 引用准备的稳定字段与命令。

安装命令
npx skills add https://github.com/gohypergiant/agent-skills --skill readme-writer
分类
</>开发工具
认证
收录时间
2026-02-01
更新时间
2026-02-18

快速解答

什么是 readme-writer?

在任何项目或包中创建或编辑 README.md 文件时使用。递归地解析自述文件位置的代码库,根据缺失或更改的功能提出更改建议,并生成完整的、听起来人性化的文档,其中包含可复制粘贴的代码块和实际示例。 来源:gohypergiant/agent-skills。

如何安装 readme-writer?

打开你的终端或命令行工具(如 Terminal、iTerm、Windows Terminal 等) 复制并运行以下命令:npx skills add https://github.com/gohypergiant/agent-skills --skill readme-writer 安装完成后,技能将自动配置到你的 AI 编程环境中,可以在 Claude Code 或 Cursor 中使用

这个 Skill 的源码在哪?

https://github.com/gohypergiant/agent-skills