developer-onboarding
新しい開発者がスムーズに開発に参加できるよう、環境構築手順、README、貢献ガイドライン、入門チュートリアルなど、包括的なドキュメントを作成するSkill。
📜 元の英語説明(参考)
Create comprehensive developer onboarding documentation including setup guides, README files, contributing guidelines, and getting started tutorials. Use when onboarding new developers or creating setup documentation.
🇯🇵 日本人クリエイター向け解説
新しい開発者がスムーズに開発に参加できるよう、環境構築手順、README、貢献ガイドライン、入門チュートリアルなど、包括的なドキュメントを作成するSkill。
※ jpskill.com 編集部が日本のビジネス現場向けに補足した解説です。Skill本体の挙動とは独立した参考情報です。
下記のコマンドをコピーしてターミナル(Mac/Linux)または PowerShell(Windows)に貼り付けてください。 ダウンロード → 解凍 → 配置まで全自動。
mkdir -p ~/.claude/skills && cd ~/.claude/skills && curl -L -o developer-onboarding.zip https://jpskill.com/download/21407.zip && unzip -o developer-onboarding.zip && rm developer-onboarding.zip
$d = "$env:USERPROFILE\.claude\skills"; ni -Force -ItemType Directory $d | Out-Null; iwr https://jpskill.com/download/21407.zip -OutFile "$d\developer-onboarding.zip"; Expand-Archive "$d\developer-onboarding.zip" -DestinationPath $d -Force; ri "$d\developer-onboarding.zip"
完了後、Claude Code を再起動 → 普通に「動画プロンプト作って」のように話しかけるだけで自動発動します。
💾 手動でダウンロードしたい(コマンドが難しい人向け)
- 1. 下の青いボタンを押して
developer-onboarding.zipをダウンロード - 2. ZIPファイルをダブルクリックで解凍 →
developer-onboardingフォルダができる - 3. そのフォルダを
C:\Users\あなたの名前\.claude\skills\(Win)または~/.claude/skills/(Mac)へ移動 - 4. Claude Code を再起動
⚠️ ダウンロード・利用は自己責任でお願いします。当サイトは内容・動作・安全性について責任を負いません。
🎯 このSkillでできること
下記の説明文を読むと、このSkillがあなたに何をしてくれるかが分かります。Claudeにこの分野の依頼をすると、自動で発動します。
📦 インストール方法 (3ステップ)
- 1. 上の「ダウンロード」ボタンを押して .skill ファイルを取得
- 2. ファイル名の拡張子を .skill から .zip に変えて展開(macは自動展開可)
- 3. 展開してできたフォルダを、ホームフォルダの
.claude/skills/に置く- · macOS / Linux:
~/.claude/skills/ - · Windows:
%USERPROFILE%\.claude\skills\
- · macOS / Linux:
Claude Code を再起動すれば完了。「このSkillを使って…」と話しかけなくても、関連する依頼で自動的に呼び出されます。
詳しい使い方ガイドを見る →- 最終更新
- 2026-05-18
- 取得日時
- 2026-05-18
- 同梱ファイル
- 10
📖 Skill本文(日本語訳)
※ 原文(英語/中国語)を Gemini で日本語化したものです。Claude 自身は原文を読みます。誤訳がある場合は原文をご確認ください。
開発者オンボーディング
目次
概要
新しい開発者が開発環境を迅速にセットアップし、コードベースを理解し、効果的に貢献を開始できるよう、包括的なオンボーディングドキュメントを作成します。
使用場面
- 新しい開発者のオンボーディング
- README ファイルの作成
- 貢献ガイドライン
- 開発環境のセットアップ
- アーキテクチャ概要ドキュメント
- コードスタイルガイド
- Git ワークフローのドキュメント
- テストガイドライン
- デプロイ手順
クイックスタート
最小限の動作例:
# Project Name
Brief project description (1-2 sentences explaining what this project does).
[](https://github.com/username/repo/actions)
[](https://codecov.io/gh/username/repo)
[](LICENSE)
[](https://www.npmjs.com/package/package-name)
## Table of Contents
- [Features](#features)
- [Quick Start](#quick-start)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Configuration](#configuration)
- [Development](#development)
- [Testing](#testing)
- [Deployment](#deployment)
- [Architecture](#architecture)
- [Contributing](#contributing)
- [License](#license)
## Features
// ... (see reference guides for full implementation)
```
## リファレンスガイド
`references/` ディレクトリにある詳細な実装:
| ガイド | 内容 |
|---|---|
| [リポジトリのクローン](references/clone-the-repository.md) | リポジトリのクローン、依存関係のインストール |
| [環境変数の設定](references/set-up-environment-variables.md) | 環境変数の設定 |
| [データベースのセットアップ](references/database-setup.md) | データベースのセットアップ、インストールの検証 |
| [プロジェクト構造](references/project-structure.md) | プロジェクト構造 |
| [利用可能なスクリプト](references/available-scripts.md) | 利用可能なスクリプト |
| [コードスタイル](references/code-style.md) | コードスタイル |
| [Git ワークフロー](references/git-workflow.md) | Git ワークフロー |
| [テストの実行](references/running-tests.md) | テストの実行 |
| [テストの記述](references/writing-tests.md) | テストの記述 |
## ベストプラクティス
### ✅ するべきこと
- 明確で簡潔なプロジェクトの説明から始める
- ビルドステータス、カバレッジなどのバッジを含める
- クイックスタートセクションを提供する
- すべての前提条件を明確に文書化する
- トラブルシューティングセクションを含める
- README を最新の状態に保つ
- コード例を豊富に使う
- アーキテクチャ図を追加する
- 環境変数を文書化する
- 貢献ガイドラインを含める
- コードスタイルの要件を明記する
- テスト手順を文書化する
### ❌ するべきではないこと
- 事前知識を前提とする
- 前提条件の文書化を省略する
- 大規模な変更後に更新を忘れる
- 過度に専門的な専門用語を使用する
- コード例を省略する
- Windows/Mac/Linux の違いを無視する
- スクリプトの文書化を忘れる 📜 原文 SKILL.md(Claudeが読む英語/中国語)を展開
Developer Onboarding
Table of Contents
Overview
Create comprehensive onboarding documentation that helps new developers quickly set up their development environment, understand the codebase, and start contributing effectively.
When to Use
- New developer onboarding
- README file creation
- Contributing guidelines
- Development environment setup
- Architecture overview docs
- Code style guides
- Git workflow documentation
- Testing guidelines
- Deployment procedures
Quick Start
Minimal working example:
# Project Name
Brief project description (1-2 sentences explaining what this project does).
[](https://github.com/username/repo/actions)
[](https://codecov.io/gh/username/repo)
[](LICENSE)
[](https://www.npmjs.com/package/package-name)
## Table of Contents
- [Features](#features)
- [Quick Start](#quick-start)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Configuration](#configuration)
- [Development](#development)
- [Testing](#testing)
- [Deployment](#deployment)
- [Architecture](#architecture)
- [Contributing](#contributing)
- [License](#license)
## Features
// ... (see reference guides for full implementation)
```
## Reference Guides
Detailed implementations in the `references/` directory:
| Guide | Contents |
|---|---|
| [Clone the Repository](references/clone-the-repository.md) | Clone the Repository, Install Dependencies |
| [Set Up Environment Variables](references/set-up-environment-variables.md) | Set Up Environment Variables |
| [Database Setup](references/database-setup.md) | Database Setup, Verify Installation |
| [Project Structure](references/project-structure.md) | Project Structure |
| [Available Scripts](references/available-scripts.md) | Available Scripts |
| [Code Style](references/code-style.md) | Code Style |
| [Git Workflow](references/git-workflow.md) | Git Workflow |
| [Running Tests](references/running-tests.md) | Running Tests |
| [Writing Tests](references/writing-tests.md) | Writing Tests |
## Best Practices
### ✅ DO
- Start with a clear, concise project description
- Include badges for build status, coverage, etc.
- Provide a quick start section
- Document all prerequisites clearly
- Include troubleshooting section
- Keep README up-to-date
- Use code examples liberally
- Add architecture diagrams
- Document environment variables
- Include contribution guidelines
- Specify code style requirements
- Document testing procedures
### ❌ DON'T
- Assume prior knowledge
- Skip prerequisite documentation
- Forget to update after major changes
- Use overly technical jargon
- Skip example code
- Ignore Windows/Mac/Linux differences
- Forget to document scripts 同梱ファイル
※ ZIPに含まれるファイル一覧。`SKILL.md` 本体に加え、参考資料・サンプル・スクリプトが入っている場合があります。
- 📄 SKILL.md (3,393 bytes)
- 📎 references/available-scripts.md (1,119 bytes)
- 📎 references/clone-the-repository.md (250 bytes)
- 📎 references/code-style.md (567 bytes)
- 📎 references/database-setup.md (456 bytes)
- 📎 references/git-workflow.md (1,123 bytes)
- 📎 references/project-structure.md (1,017 bytes)
- 📎 references/running-tests.md (237 bytes)
- 📎 references/set-up-environment-variables.md (659 bytes)
- 📎 references/writing-tests.md (1,603 bytes)