Readme Builder

职业

分类

技术文档

Discovery Phase (Mandatory Before Writing)

Before generating any README content, answer these questions by scanning the project:

1. What does this project do? (single sentence)
2. Who is the target user? (developer / end-user / enterprise)
3. What problem does it solve?
4. What are the installation prerequisites?
5. What is the primary command or API entry point?
6. Does it have a license file?
7. Are there screenshots, demos, or GIFs available?
8. Is there a CONTRIBUTING.md or CODE_OF_CONDUCT.md?
9. What CI/CD badges are relevant? (GitHub Actions, npm, PyPI, etc.)
10. What is the current version?

README Structure Template

# [Project Name]

[One-line tagline: what it does and for whom]

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Version](https://img.shields.io/npm/v/package-name)](https://www.npmjs.com/package/package-name)
[![Build Status](https://github.com/user/repo/workflows/CI/badge.svg)](https://github.com/user/repo/actions)

[Optional: Screenshot or GIF Demo]

---

## ✨ Features

- **Feature 1** — specific, concrete description
- **Feature 2** — specific, concrete description
- **Feature 3** — specific, concrete description

---

## 📋 Prerequisites

- Node.js 18+ / Python 3.11+ / etc.
- [Any specific tool or account required]

---

## 🚀 Installation

```bash
# npm
npm install package-name

# or yarn
yarn add package-name

# or global CLI install
npm install -g package-name

💻 Usage

Basic Example

# One-liner that shows the most common use case
package-name --flag value

Advanced Example

# More complex real-world usage
package-name init --config ./config.json --output ./dist

⚙️ Configuration

🤝 Contributing

1. Fork the repository
2. Create a feature branch: git checkout -b feat/your-feature
3. Commit changes: git commit -m "feat: add your feature"
4. Push to branch: git push origin feat/your-feature
5. Open a Pull Request

See CONTRIBUTING.md for detailed guidelines.

📄 License

MIT © [Author Name]

---

## Badge Reference

### Common Badges (GitHub-hosted project)

```markdown
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![npm version](https://badge.fury.io/js/PACKAGE-NAME.svg)](https://badge.fury.io/js/PACKAGE-NAME)
[![npm downloads](https://img.shields.io/npm/dm/PACKAGE-NAME.svg)](https://www.npmjs.com/package/PACKAGE-NAME)
[![GitHub stars](https://img.shields.io/github/stars/USER/REPO.svg?style=social)](https://github.com/USER/REPO)
[![GitHub issues](https://img.shields.io/github/issues/USER/REPO.svg)](https://github.com/USER/REPO/issues)
[![CI](https://github.com/USER/REPO/workflows/CI/badge.svg)](https://github.com/USER/REPO/actions)
[![Coverage](https://img.shields.io/codecov/c/github/USER/REPO)](https://codecov.io/gh/USER/REPO)

Section Writing Guidelines

Hero Section (Lines 1–5)

• Project name as # H1 — only one per README
• Tagline in a > blockquote — punchy, one sentence
• Badges immediately after — visual trust signals

Features Section

• Use emoji bullets for scannability
• Each bullet = one concrete capability, not a vague claim
• ❌ "Powerful and flexible" → ✅ "Processes 10k records/sec with zero config"

Installation Section

• Always show the most direct path first (e.g., npm install)
• Show alternatives (yarn, pnpm, brew) as secondary options
• If there are post-install steps (env vars, migrations), list them explicitly

Usage Section

• Start with the simplest 1-line example
• Progress to realistic examples with real flag names
• If it's a library, show import + function call pattern

Configuration Table

• Every environment variable or config key goes here
• Include: name, type, default, description
• Mark required fields with * in the Description column

Project-Type Specific Additions

CLI Tools

Add a dedicated ## Commands section:

## Commands

|Command|Description|
|---------|-------------|
|`tool init`|Initialize a new project|
|`tool build`|Compile and bundle|
|`tool deploy`|Deploy to production|
|`tool --help`|Show all available options|

Libraries / SDKs

Add a ## API Reference section with function signatures:

## API Reference

### `functionName(param1, param2)`

Returns: `ReturnType`

|Parameter|Type|Description|
|-----------|------|-------------|
|`param1`|`string`|Description|
|`param2`|`options`|Optional config|

Monorepos

Add a ## Packages table:

## Packages

|Package|Version|Description|
|---------|---------|-------------|
|[`@org/core`](packages/core)|[![npm](https://img.shields.io/npm/v/@org/core)](https://npm.im/@org/core)|Core engine|
|[`@org/cli`](packages/cli)|[![npm](https://img.shields.io/npm/v/@org/cli)](https://npm.im/@org/cli)|CLI interface|

Output Format

When this skill generates or reviews a README, structure your response as:

━━━ README Builder Report ━━━━━━━━━━━━━━━━━━━━━━━━━
Skill:       readme-builder
Project:     [project name / type detected]
Sections:    [list of sections generated]
─────────────────────────────────────────────────────
✅ Included: [sections that are complete]
⚠️  Missing:  [sections that should be added]
❌ Blocked:  [issues preventing completion]
─────────────────────────────────────────────────────
VBC status:  PENDING → VERIFIED
Evidence:    [file written at path / content reviewed]