MCP HubMCP Hub
スキル一覧に戻る

crafting-effective-readmes

majiayu000
更新日 Today
21 閲覧
58
9
58
GitHubで表示
メタdesign

について

このClaudeスキルは、開発者が対象読者に応じたテンプレートとガイダンスを提供することで、READMEファイルの作成と改善を支援します。プロジェクトタイプに基づいて、ドキュメントの作成、更新、レビューといった様々なタスクに対応する構造化されたプロセスを提供します。READMEを執筆する際にご利用いただくことで、対象読者に適切な情報を効果的に伝えることができます。

クイックインストール

Claude Code

推奨
プラグインコマンド推奨
/plugin add https://github.com/majiayu000/claude-skill-registry
Git クローン代替
git clone https://github.com/majiayu000/claude-skill-registry.git ~/.claude/skills/crafting-effective-readmes

このコマンドをClaude Codeにコピー&ペーストしてスキルをインストールします

ドキュメント

Crafting Effective READMEs

Overview

READMEs answer questions your audience will have. Different audiences need different information - a contributor to an OSS project needs different context than future-you opening a config folder.

Always ask: Who will read this, and what do they need to know?

Process

Step 1: Identify the Task

Ask: "What README task are you working on?"

TaskWhen
CreatingNew project, no README yet
AddingNeed to document something new
UpdatingCapabilities changed, content is stale
ReviewingChecking if README is still accurate

Step 2: Task-Specific Questions

Creating initial README:

  1. What type of project? (see Project Types below)
  2. What problem does this solve in one sentence?
  3. What's the quickest path to "it works"?
  4. Anything notable to highlight?

Adding a section:

  1. What needs documenting?
  2. Where should it go in the existing structure?
  3. Who needs this info most?

Updating existing content:

  1. What changed?
  2. Read current README, identify stale sections
  3. Propose specific edits

Reviewing/refreshing:

  1. Read current README
  2. Check against actual project state (package.json, main files, etc.)
  3. Flag outdated sections
  4. Update "Last reviewed" date if present

Step 3: Always Ask

After drafting, ask: "Anything else to highlight or include that I might have missed?"

Project Types

TypeAudienceKey SectionsTemplate
Open SourceContributors, users worldwideInstall, Usage, Contributing, Licensetemplates/oss.md
PersonalFuture you, portfolio viewersWhat it does, Tech stack, Learningstemplates/personal.md
InternalTeammates, new hiresSetup, Architecture, Runbookstemplates/internal.md
ConfigFuture you (confused)What's here, Why, How to extend, Gotchastemplates/xdg-config.md

Ask the user if unclear. Don't assume OSS defaults for everything.

Essential Sections (All Types)

Every README needs at minimum:

  1. Name - Self-explanatory title
  2. Description - What + why in 1-2 sentences
  3. Usage - How to use it (examples help)

References

  • section-checklist.md - Which sections to include by project type
  • style-guide.md - Common README mistakes and prose guidance
  • using-references.md - Guide to deeper reference materials

GitHub リポジトリ

majiayu000/claude-skill-registry
パス: skills/crafting-effective-readmes

関連スキル

content-collections

メタ

This skill provides a production-tested setup for Content Collections, a TypeScript-first tool that transforms Markdown/MDX files into type-safe data collections with Zod validation. Use it when building blogs, documentation sites, or content-heavy Vite + React applications to ensure type safety and automatic content validation. It covers everything from Vite plugin configuration and MDX compilation to deployment optimization and schema validation.

スキルを見る

creating-opencode-plugins

メタ

This skill provides the structure and API specifications for creating OpenCode plugins that hook into 25+ event types like commands, files, and LSP operations. It offers implementation patterns for JavaScript/TypeScript modules that intercept and extend the AI assistant's lifecycle. Use it when you need to build event-driven plugins for monitoring, custom handling, or extending OpenCode's capabilities.

スキルを見る

polymarket

メタ

This skill enables developers to build applications with the Polymarket prediction markets platform, including API integration for trading and market data. It also provides real-time data streaming via WebSocket to monitor live trades and market activity. Use it for implementing trading strategies or creating tools that process live market updates.

スキルを見る

langchain

メタ

LangChain is a framework for building LLM applications using agents, chains, and RAG pipelines. It supports multiple LLM providers, offers 500+ integrations, and includes features like tool calling and memory management. Use it for rapid prototyping and deploying production systems like chatbots, autonomous agents, and question-answering services.

スキルを見る