mcpField
D
developer-onboarding

developer-onboarding

github.com/aj-geddes開発373474 回インストール34 週間前に更新
リポジトリ

developer-onboarding について

新しい開発者が環境を整え、コードベースを理解して作業を始められるよう、オンボーディング文書の作成を支援するスキルです。プロジェクトや開発関連文書の参考ガイドと作成上の指針を提供します。

主な機能

  1. 01開発者向けオンボーディング文書
  2. 02環境構築ガイド
  3. 03プロジェクト構成とアーキテクチャ文書
  4. 04Git、コードスタイル、テストのガイド
  5. 05READMEとコントリビューションガイド

活用シーン

  1. 01新しいチームメンバー向け資料の準備
  2. 02ローカル開発の前提条件の文書化
  3. 03プロジェクトの貢献方法とテスト指針の作成

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill developer-onboarding

インストール後、Claude Code で/developer-onboardingを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
available-scripts.md
clone-the-repository.md
code-style.md
database-setup.md
git-workflow.md
project-structure.md
running-tests.md
set-up-environment-variables.md
writing-tests.md
templates/
doc-template.md

詳細

開発者向けオンボーディング

目次

概要

新しい開発者が開発環境をすばやくセットアップし、コードベースを理解して、効果的に貢献を始められるよう支援する、包括的なオンボーディングドキュメントを作成します。

使用する場面

  • 新しい開発者のオンボーディング
  • README ファイルの作成
  • コントリビューションガイドライン
  • 開発環境のセットアップ
  • アーキテクチャ概要ドキュメント
  • コードスタイルガイド
  • Git ワークフローのドキュメント
  • テストガイドライン
  • デプロイ手順

クイックスタート

最小限の動作例：

# Project Name

Brief project description (1-2 sentences explaining what this project does).

[![Build Status](https://img.shields.io/github/workflow/status/username/repo/CI)](https://github.com/username/repo/actions)
[![Coverage](https://img.shields.io/codecov/c/github/username/repo)](https://codecov.io/gh/username/repo)
[![License](https://img.shields.io/github/license/username/repo)](LICENSE)
[![Version](https://img.shields.io/npm/v/package-name)](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

コメント

Markdown 対応