readme-generator

仓库创建 2026年4月14日最近提交 20 天前SkillHot 收录 20 天前
▸ 精选理由

快速把项目要点整理成发布与使用文档,节省沟通成本。

这个 Skill 做什么

为项目生成或更新结构化、完整的 README.md 文档。

把项目的 README.md 按模板生成或更新,包含项目名、简介、目录、功能、安装与运行步骤、技术栈、文件结构、许可证和变更历史等信息。需要发布项目、开源或把文档跟实现同步时用,能帮你把零散信息整理成结构化文档。输出简洁且面向读者,方便新人快速上手和对外发布。

▸ 展开 SKILL.md 英文原文

プロジェクトのREADME.mdを作成・更新するスキル。プロジェクト名、概要、目次、機能一覧、環境構築、実行方法、技術スタック、ファイル構成、ライセンス、変更履歴を簡潔にまとめたREADMEを生成する。「READMEを作って」「README更新」「README生成」「ドキュメント作成」「プロジェクト説明を書いて」「ドキュメント整備」「プロジェクト紹介」「使い方を書いて」「READMEを最新にして」「readme」「documentation」「docs」などで発火。

内容创作README生成项目文档发布说明通用
0
Stars
0
Forks
28
仓库内 Skill
+0
7 日增星
安装 / 使用
给你的 Agent 一句话(通用)
帮我安装这个 skill:https://raw.githubusercontent.com/safubuki/turtle-ai-code-quartet-hub/main/.agents/skills/readme-generator/SKILL.md
或 curl 直取 SKILL.md
curl -fsSL "https://raw.githubusercontent.com/safubuki/turtle-ai-code-quartet-hub/main/.agents/skills/readme-generator/SKILL.md"
SKILL.MD 节选查看完整文件 ↗
# README Generator Skill

## スキル読み込み通知

このスキルが読み込まれたら、必ず以下の通知をユーザーに表示してください:

> 💡 **README Generator スキルを読み込みました**  
> プロジェクトのREADME.mdを作成・更新します。

## When to Use

- プロジェクトの README.md を新規作成したいとき
- README.md を最新の実装に合わせて更新したいとき
- プロジェクトの公開に向けて README を整備したいとき
- バージョンアップ後に変更履歴を反映したいとき
- 「このプロジェクトの説明を書いてほしい」とき
- 既存の README が古くなって実態と乖離しているとき

## README 作成ガイドライン

### 簡潔さの原則

README は**ユーザーが参照したらすぐに理解できて、簡潔にまとまっている**ことが最も重要です。以下を心がけてください:

- 環境構築・実行方法はコマンド数行で完結させる
- 長文の説明より箇条書きと表を使う
- 「とりあえず動かす」ための最短パスを最初に示す
- 詳細は別ドキュメントへのリンクで誘導する

## README テンプレート

以下のテンプレートに沿って README を生成してください:

📄 **[assets/readme-template.md](assets/readme-template.md)**

各セクションは実際のプロジェクトから情報を収集して埋めます。

## 情報収集の手順

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