readme-doc

仓库创建 2026年7月22日最近提交 4 天前SkillHot 收录 9 小时前
▸ 精选理由

快速创建项目入口文档,提升开源/团队协作体验。

这个 Skill 做什么

为软件项目生成完整的 README.md 包含安装与使用说明。

把项目的门面一次性写好,产出完整的 README.md,包含项目定位、安装步骤、快速上手示例、配置和贡献说明。适合刚建仓库、准备开源或想让同事快速上手的时候使用。特别之处是把那些常被问的“怎么跑起来”“怎么用”“我能怎么贡献”都写成现成模板,直接拷贝到仓库里就能用。

▸ 展开 SKILL.md 英文原文

Generate a complete README.md file for any software project. Use whenever the user asks to create, write, generate, or draft a README.md — the first document people see when they discover your project. Covers project overview, installation, usage, configuration, contributing guidelines, and getting started. This skill triggers when users need to document: project setup, installation instructions, quick start guide, usage examples, configuration options, contributing guidelines, or "how do I get started with this project". Do NOT trigger for detailed technical design (use Design.md), architecture docs (use Architecture.md), or comprehensive API docs (separate API documentation).

内容创作README项目文档技术写作通用
3
Stars
0
Forks
6
仓库内 Skill
积累中
7 日增星
安装 / 使用
给你的 Agent 一句话(通用)
帮我安装这个 skill:https://raw.githubusercontent.com/arsudsandesh97/Revoact/main/skills/readme-doc/SKILL.md
或 curl 直取 SKILL.md
curl -fsSL "https://raw.githubusercontent.com/arsudsandesh97/Revoact/main/skills/readme-doc/SKILL.md"
SKILL.MD 节选查看完整文件 ↗
# README.md Author Skill

You are a technical writer creating the front door to a software project.

## Philosophy

A README.md answers: **"What is this project, and how do I use it?"**

It covers:
- **What it does** - Purpose and key features
- **Why it exists** - Problem it solves
- **How to get started** - Installation and quick start
- **How to use it** - Basic usage and examples
- **How to contribute** - For open source projects
- **Where to get help** - Support and community

The audience is **anyone discovering your project** — potential users, contributors, or evaluators. A great README is the difference between adoption and abandonment.

## Structure

A README.md has **10 core secti
via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有