readme-standards について
プロジェクトの README を作成・改善する開発者向けに、テンプレートと記述基準を提供するスキルです。プロジェクトの種類や詳しさに応じた構成に加え、バッジ、技術スタック、チェック項目も扱います。
主な機能
- 01簡潔・標準・詳細テンプレート
- 02プロジェクト種別ごとのテンプレート
- 03バッジとロゴのガイドライン
- 04README の適合チェック項目
活用シーン
- 01新規プロジェクトの README 構成選び
- 02既存 README の不足項目の確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/readme-standardsを入力して読み込まれたか確認します。
詳細
README の標準（v2025.1）
このスキルでは、プロジェクト向けの README.md テンプレートと標準を提供します。
概要
適切に構成された README は、プロジェクトの入口です。次の点を満たす必要があります。
- プロジェクトの機能をすぐに伝える
- 適切なブランディングでプロフェッショナルな印象を与える
- わかりやすい導入手順を提供する
- 視覚的な階層構造が整っていて、内容を把握しやすい
テンプレートのスタイル
ミニマルスタイル
最適な用途：ライブラリ、小規模なユーティリティ、社内ツール
# project-name
[](LICENSE)
Brief description of what this project does.
## Installation
```bash
npm install package-name
使用方法
import { feature } from 'package-name';
feature();
ライセンス
MIT
### Standard Style (Recommended)
Best for: Most projects, applications, services
```markdown
<div align="center">
<img src="assets/logo.png" alt="Project Logo" width="128">
# Project Name
**A compelling tagline that explains the project's purpose**
[](LICENSE)
[](https://github.com/OWNER/REPO/stargazers)
[](https://github.com/OWNER/REPO/actions)
[]()
</div>
## Features
- **Feature One** - Description of the first key capability
- **Feature Two** - Description of the second key capability
- **Feature Three** - Description of the third key capability
- **Feature Four** - Description of the fourth key capability
## Tech Stack
| Category | Technology |
|----------|------------|
| Runtime | Bun 1.x |
| Framework | Fastify |
| Frontend | React 18, Vite |
| Database | SQLite (Drizzle ORM) |
| Testing | Vitest, Playwright |
## Getting Started
### Prerequisites
- [Bun](https://bun.sh) >= 1.0
- [Node.js](https://nodejs.org) >= 20 (optional)
### Installation
```bash
# Clone the repository
git clone https://github.com/OWNER/REPO.git
cd REPO
# Install dependencies
bun install
# Start development server
bun run dev
開発コマンド
bun run dev # Start development server
bun run build # Build for production
bun run test # Run tests
bun run lint # Run linter
プロジェクト構成
project-name/
├── src/
│ ├── client/ # Frontend React application
│ │ ├── components/ # UI components
│ │ └── stores/ # State management
│ ├── server/ # Backend Fastify server
│ │ ├── routes/ # API endpoints
│ │ └── services/ # Business logic
│ └── shared/ # Shared types and utilities
├── tests/ # Test files
├── docs/ # Documentation
└── README.md
コントリビューション
コントリビューションを歓迎します。お気軽にプルリクエストを送信してください。
ライセンス
このプロジェクトは、MIT License のもとでライセンスされています。
### Detailed Style
Best for: Open source projects, documentation-heavy projects, developer tools
Includes everything from Standard plus:
- Architecture diagrams (Mermaid)
- API reference section
- Detailed configuration options
- Changelog link
- Security policy
- Code of conduct reference
## Badge Reference
### Repository Status Badges
```markdown
[](LICENSE)
[](https://github.com/OWNER/REPO/stargazers)
[](https://github.com/OWNER/REPO/network/members)
[](https://github.com/OWNER/REPO/issues)
[](https://github.com/OWNER/REPO/commits)
CI/CD ステータスバッジ
[](https://github.com/OWNER/REPO/actions)
[](https://github.com/OWNER/REPO/actions/workflows/build.yml)
[](https://codecov.io/gh/OWNER/REPO)
パッケージレジストリのバッジ
[](https://www.npmjs.com/package/PACKAGE)
[](https://www.npmjs.com/package/PACKAGE)
[](https://pypi.org/project/PACKAGE/)
[](https://pypi.org/project/PACKAGE/)
[](https://crates.io/crates/PACKAGE)
[](https://docs.rs/PACKAGE)
[](https://pkg.go.dev/github.com/OWNER/REPO)
テクノロジーバッジ
[]()
[]()
[]()
[]()
[]()
[]()
[]()
[]()
[]()
[]()
[]()
ロゴのガイドライン
推奨仕様
- 形式：PNG（透過あり）または SVG
- サイズ：128x128px から 512x512px
- 場所：
assets/logo.pngまたはassets/icon.svg
ロゴの中央揃え
<div align="center">
<img src="assets/logo.png" alt="Project Name" width="128">
</div>
プレースホルダーとして絵文字を使用する
ロゴがない場合：
<div align="center">
# 🚀 Project Name
</div>
プロジェクトの種類によく使われる絵文字：
- 🚀 - 汎用／デプロイツール
- 🛠️ - 開発者ツール
- 📊 - データ／分析
- 🔒 - セキュリティ
- 🌐 - Web アプリケーション
- 📱 - モバイルアプリ
- 🤖 - AI／ML プロジェクト
- 📦 - パッケージ／ライブラリ
セクションのガイドライン
機能セクション
機能は、単なる能力ではなく、ユーザーにとってのメリットとして記述します。
良い例：
- **Automatic Scanner Detection** - Discovers eSCL-compatible scanners via mDNS without manual configuration
- **Smart Photo Separation** - Intelligently detects and crops multiple photos from a single scan using edge analysis
比較 — 実装重視（効果が低い）：
- Uses mDNS for scanner discovery
- Has edge detection algorithm
技術スタックのセクション
わかりやすいよう、表を使用します。
| Category | Technology |
|----------|------------|
| Runtime | Bun 1.x |
| Server | Fastify 4 |
| Frontend | React 18, Tailwind CSS |
| Database | SQLite (Drizzle ORM) |
はじめにのセクション
必ず次の内容を含めます。
- バージョン要件を含む前提条件
- クローン手順
- 依存関係のインストールコマンド
- 実行コマンド
- （任意）環境設定
プロジェクト構成のセクション
- 階層は 2～3 レベルに抑える
- 意味のあるディレクトリのみを表示する
- 一見してわかりにくいフォルダーには簡単なコメントを付ける
project/
├── src/ # Source code
├── tests/ # Test files
├── docs/ # Documentation
└── scripts/ # Build/dev scripts
プロジェクトの種類別テンプレート
CLI ツール
## Installation
```bash
# With npm
npm install -g tool-name
# With Bun
bun install -g tool-name
# Or run directly
npx tool-name
使用方法
tool-name <command> [options]
Commands:
init Initialize a new project
build Build the project
deploy Deploy to production
Options:
-h, --help Show help
-v, --version Show version
### Library/Package
```markdown
## Installation
```bash
npm install package-name
# or
bun add package-name
使用方法
import { feature } from 'package-name';
const result = feature({
option: 'value'
});
API
feature(options)
関数の説明。
パラメーター：
options.key（string）- 説明
戻り値： ReturnType - 説明
### Web Application
```markdown
## Demo
🌐 [Live Demo](https://demo.example.com)
## Screenshots
<div align="center">
<img src="docs/screenshots/dashboard.png" alt="Dashboard" width="600">
</div>
## Environment Variables
Create a `.env` file:
```env
DATABASE_URL=postgresql://...
API_KEY=your-api-key
## Compliance Checklist
### Minimal Style
- [ ] Title (h1)
- [ ] Description (1-2 sentences)
- [ ] License badge
- [ ] Installation instructions
- [ ] Basic usage example
- [ ] License section
### Standard Style (all of minimal plus)
- [ ] Logo or emoji header
- [ ] 3+ badges (license, stars, CI)
- [ ] Features section (4+ items)
- [ ] Tech stack table
- [ ] Prerequisites
- [ ] Development commands
- [ ] Project structure
- [ ] Contributing mention
### Detailed Style (all of standard plus)
- [ ] Architecture diagram
- [ ] API reference or link
- [ ] Configuration options
- [ ] Changelog link
- [ ] Security policy mention
- [ ] Code of conduct mention
## Cookiecutter Integration
For creating entire new projects from templates, consider using [cookiecutter](https://cookiecutter.readthedocs.io/):
```bash
# Install cookiecutter
pip install cookiecutter
# or
uv tool install cookiecutter
# Create project from template
cookiecutter https://github.com/your-org/project-template
Cookiecutter は次の用途に最適です。
- 一貫した構成のプロジェクトを複数作成する
- 組織全体で使用するプロジェクトテンプレートを作成する
- README だけでなく、プロジェクト全体のひな形を含める
/configure:readme コマンドは次の用途に適しています。
- 既存のプロジェクトを更新する
- すでにコードがあるプロジェクトの README を生成する
- 既存の README の準拠状況を確認する
コメント
Markdown 対応