readme-craft SKILL.md skillA
readme-craft from hanzhangzzz/agent-skills-zh is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add hanzhangzzz/agent-skills-zh/readme-craft@git:20260928.8b03b06Pins git:20260928.8b03b06 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- hanzhangzzz/agent-skills-zh
- Path
readme-craft/SKILL.md- Versions recorded
- 2
- Latest version
- git:20260928.8b03b06, committed Sep 28, 2026
- First version recorded
- Sep 25, 2026
- Size
- 6,906 bytes
- Repository stars
- 1
- License
- MIT
为开源项目撰写、重写或审查仓库 README：让读者迅速判断项目是否解决自己的问题，尽快完成第一次真实使用，并逐步理解原理与边界。用于“写 README”“优化开源项目首页”“README 审查”“3 秒抓眼球、30 秒开始、1 分钟懂原理”等请求；不用于 GitHub 个人主页 README 或纯 Markdown 排版美化。.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# readme-craft 把 README 当成陌生人第一次使用项目的入口。目标是让对的人愿意试、试得成、知道何时不该用；Star 只能是结果，不是文案的真实性标准。 同系列：`launch-video` 用同一套证据制作 30 秒发布视频；README 定稿后再做视频，二者的定位句、证据与安装命令保持一致。 “3 秒 / 30 秒 / 1 分钟”是**信息可见性目标**，不是阅读速度或增长承诺：首屏看出用途与价值；紧接着找到可执行的第一步；继续读能理解输入、关键机制与输出。按项目类型调整篇幅和媒介，不用固定标题凑齐三段。 ## 适用与交付 - 新写：交付仓库根目录的 `README.md`，使用项目已有语言约定；用户只要草稿时交付草稿，不擅自改仓库。 - 重写：保留经过核实的安装、许可、兼容性、限制和贡献信息；删除已失效或重复内容。 - 审查：指出最影响首次使用的少数问题，给出可直接替换的文字或修改后的文件；不要只给打分。 - 项目已有生成器、国际化来源文件或 README 自动同步机制时，修改源头并重新生成；不要手改生成产物。 ## 先取证，再写承诺 1. 读项目说明、入口代码、包元数据、示例、发布产物、测试与现有文档，确定**目标读者、具体问题、可观察结果、差异及适用边界**。用户有明确定位时沿用，并核对实现。源码仅能证明实现意图；运行结果、发布状态和外部采用分别需要各自证据。 2. 从现有公开安装或运行方式中选一条门槛最低、能看到价值的路径。核对前置条件、版本、平台、凭据、费用、数据外发、样例输入和预期输出。无法运行时只写已核实部分，并标明未验证，不能把示意命令写成“复制即用”。 3. 明确项目形态：CLI 展示输入命令与输出；库展示最小代码与返回值；应用展示入口和关键界面；Agent skill 展示安装、调用及可检查的产物；数据/研究项目展示数据来源与复现条件。项目没有可用的最短路径时，先修阻断或如实说明，不靠文案掩盖。 4. 吸收同类优秀 README 的表达方式，只借信息组织和展示手法；功能、数据、评价、截图与基准必须来自本项目的可核实证据。不要由 Star 数反推文案有效，也不要复制他人承诺。 ## 按读者的决策顺序组织 **首屏：判断值不值得看。** 用项目名与一句具体描述说清“谁，用什么，得到什么”。紧接一张真实结果图、短输出或极短示例，选择最能证明价值的媒介。给一个清楚的下一步链接。差异只写可验证的事实；避免“强大、革命性、最简单”等空词、徽章墙、长目录和架构图抢占首屏。 …
Read the whole file at its exact version.
How to install
mdr add hanzhangzzz/agent-skills-zh/readme-craft@sha256:616f7d93ea3396fdThe line at the top of this page pins the label git:20260928.8b03b06, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_7k5dipt52u2kl6ch)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Sep 25, 2026 and Sep 28, 2026, about one every 3 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260928.8b03b06 latest | 2026-09-28 | 8b03b06 | 6,906 B | A | view · diff |
| git:20260925.ac65ae2 | 2026-09-25 | ac65ae2 | 6,743 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (6906 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
hanzhangzzz/agent-skills-zh · 1 stars · license MIT · pushed 2026-10-29 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_7k5dipt52u2kl6ch GET https://markdownregistry.com/api/v1/resolve?ref=hanzhangzzz/agent-skills-zh/readme-craft GET https://markdownregistry.com/api/v1/blob/616f7d93ea3396fd8f5375ca93a6e1f7f12fae62036481189e5b1b776734431e
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from hanzhangzzz/agent-skills-zh
Every file in hanzhangzzz/agent-skills-zh