readme-generator

仓库创建 2025年12月16日最近提交 8 天前SkillHot 收录 20 天前

▸ 精选理由

以人为本的结构化 README，推荐低成本模型生成方案

这个 Skill 做什么

生成面向人的高质量 README，遵循当前文档最佳实践

把项目简介写成面向人的高质量 README.md，结构清晰、易于阅读，适合创建或重写仓库文档时使用。会把技术点、使用示例和贡献指南组织好，让新同事或开源用户马上上手。推荐用简洁的人类语言和最佳实践模板，注重可读性而不是机器优化。

▸ 展开 SKILL.md 英文原文

Use when creating or rewriting README.md for projects. Triggers on "write README", "create README", "update README". Creates human-focused documentation with proper structure.

内容创作README文档生成最佳实践通用

207

Stars

Forks

仓库内 Skill

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/serejaris/personal-corp-skills/main/skills/readme-generator/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/serejaris/personal-corp-skills/main/skills/readme-generator/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# README Generator

Generate human-focused README files following current best practices.

**Core principle:** README is for humans, not agents. Research → Analyze → Write.

**Model recommendation:** Use `Task` tool with `model: haiku` for README generation — faster and cheaper for documentation tasks.

## When to Use

- Creating README for new project
- Rewriting outdated README
- User asks "write/create/update README"

## Process

```dot
digraph readme_flow {
    rankdir=TB;
    "1. Research best practices via Exa" [shape=box];
    "2. Analyze project structure" [shape=box];
    "3. Identify project type" [shape=diamond];
    "4. Write README with appropriate sections" [shape=box];
    "5.

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有