write-readme SKILL.md skillA
write-readme from huangwb8/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add huangwb8/skills/write-readme@git:20260906.dd1fab8Pins git:20260906.dd1fab8 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- huangwb8/skills
- Path
skills/alpha/write-readme/SKILL.md- Versions recorded
- 6
- Latest version
- git:20260906.dd1fab8, committed Sep 6, 2026
- First version recorded
- Sep 5, 2026
- Size
- 13,389 bytes
- Repository stars
- 50
- License
- MIT
为 GitHub 项目创建或改写高质量、可执行、证据驱动的双语 README；当用户要求写 README、项目说明或整理项目首页时使用。优先依据项目事实核验功能、命令和链接。.
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
# write-readme ## 目标 为任意 GitHub 项目创建或改写高质量、可执行、证据驱动的双语 README；当用户说“写 README / README.md / 项目说明 / 文档首页 / GitHub 项目介绍”，或需要把 Agent Skill、库、CLI、Web 应用、服务、数据/机器学习项目整理成中文 README.md 与英文 README_EN.md 时使用。优先读取项目事实并验证命令、链接和功能，不凭空编造。 为项目写 README 的通用 Skill。它只负责项目说明文档，不改业务代码、配置或测试；默认写入项目根目录的 `README.md`（中文）和 `README_EN.md`（英文）。 ## 流程 ### 输入 #### 触发边界 适用：创建、重写、补齐或双语化项目 README；为 Agent Skill 写用户指南；根据仓库现状补 Quick Start、示例、架构、贡献或安全说明。 不适用：只改代码注释、写 API 参考手册、生成发布说明、翻译与项目无关的文章，或用户只要求审查而不允许写 README。若用户只指定一个语言，仍先确认是否应保持双语契约；本仓库默认保持两份对齐文件。 ### 执行步骤 #### 核心原则 1. **先回答“这是什么、为何有用、如何开始”**：首屏给出项目名、具体价值主张和最短成功路径。 2. **事实优先**：功能、版本、命令、徽章、性能数字、兼容性和链接必须来自仓库或明确来源；无法确认就标为待确认/不写。 3. **任务优先而非文件优先**：按用户要完成的任务组织 Quick Start、示例和导航，架构细节后置。 4. **最小可运行示例**：安装、配置、运行、预期结果形成闭环；复杂用法链接到更深文档。 5. **渐进披露**：首屏短而有用；高级部署、内部设计、故障排查和贡献流程分层展开。 6. **双语等价**：英文不是逐词直译，而是自然表达同一事实；两份文件的标题树、代码块、链接目标、版本和示例保持同步。 7. **完整 GitHub Hero**：除非项目确实是极短的索引或用户明确要求极简排版，首屏默认采用“居中标题/标识 → 事实徽章 → 导航 → 价值主张 → 解释段 → 证据或 Quick Start”的完整 Hero；视觉不可用时保留信息顺序并退化为纯 Markdown。 8. **克制装饰**：只添加能帮助判断的徽章、截图、GIF 或图表；视觉材料必须有替代文本和真实路径。 9. **诚实边界**：明确支持范围、限制、风险、数据来源、许可证和未验证事项，不用营销语气掩盖缺口。 #### 工作流 ##### 1. 建立事实清单 读取并交叉核对： …
Read the whole file at its exact version.
How to install
mdr add huangwb8/skills/write-readme@sha256:a4680edd5c006230The line at the top of this page pins the label git:20260906.dd1fab8, 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_6tjegfymc7bnirqd)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 6 versions of this file, between Sep 5, 2026 and Sep 6, 2026, more than one a day.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260906.dd1fab8 latest | 2026-09-06 | dd1fab8 | 13,389 B | A | view · diff |
| git:20260906.d2681a7 | 2026-09-06 | d2681a7 | 12,731 B | A | view · diff |
| git:20260905.a346b91 | 2026-09-05 | a346b91 | 12,927 B | A | view · diff |
| git:20260905.7c0ea7c | 2026-09-05 | 7c0ea7c | 12,888 B | A | view · diff |
| git:20260905.8faacfe | 2026-09-05 | 8faacfe | 11,422 B | A | view · diff |
| git:20260905.a39953d | 2026-09-05 | a39953d | 11,424 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 (13389 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
huangwb8/skills · 50 stars · license MIT · pushed 2026-11-01 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_6tjegfymc7bnirqd GET https://markdownregistry.com/api/v1/resolve?ref=huangwb8/skills/write-readme GET https://markdownregistry.com/api/v1/blob/a4680edd5c0062300631d4246a7e531dda6a1bb936b59b6f107b9ed58b3e5632
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.