readme-write

仓库创建 2026年6月24日最近提交 23 天前SkillHot 收录 22 天前
▸ 精选理由

适合快速产出清晰项目首页,降低新用户门槛。

这个 Skill 做什么

自动生成或重构项目 README,补全安装与使用说明。

自动生成或重构项目的 README,补全安装、配置、使用示例和快速上手步骤,把信息按新来开发者的阅读顺序组织好。新项目初始化、准备开源或想提升 README 可读性时用。特点是面向初次接触代码库的开发者,重点放在快速上手、常见问题和示例命令上。

▸ 展开 SKILL.md 英文原文

Create and update a project's README. Use when the user wants to write a readme, improve or restructure an existing one, or document a new project.

开发编程README写作项目文档开发者入门通用
0
Stars
0
Forks
5
仓库内 Skill
+0
7 日增星
安装 / 使用
给你的 Agent 一句话(通用)
帮我安装这个 skill:https://raw.githubusercontent.com/juff17/docify/master/skills/readme-write/SKILL.md
或 curl 直取 SKILL.md
curl -fsSL "https://raw.githubusercontent.com/juff17/docify/master/skills/readme-write/SKILL.md"
SKILL.MD 节选查看完整文件 ↗
A README is the first thing a developer reads about a project, and usually the
thing that decides whether they read anything else. Its audience is developers
meeting the project for the first time — people looking to understand and set
up a new tool or library, it is less for people who already know the codebase. 
Everything below follows from writing for that reader.

## The reader's order

The README is orderd to reveal information the devopers need progressviely: *what is
this?* → *how do I use it?* → *where are the docs and examples?* → *how do I
contribute?* Each question only matters if the answer to the previous one kept
the reader interested, so the document should answer them in tha
via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有