# {Project Name} > {1行で何のプロダクトか} [](https://github.com/{org}/{repo}/actions) [](LICENSE) ## What is this? {2〜3段落でプロダクトの目的・対象ユーザー・主要機能} ## Quick start ```bash git clone https://github.com/{org}/{repo}.git cd {repo} {pnpm install} cp .env.example .env # {環境変数を設定} {pnpm dev} ``` 開発サーバーが http://localhost:{3000} で起動します。 ## Tech stack - **Frontend**: {Next.js 15 / React 19 / TypeScript} - **Backend**: {Cloud Run / Node.js 22} - **Database**: {Firestore / Postgres} - **Hosting**: {Vercel / GCP} ## Scripts | Command | Description | | --- | --- | | `{pnpm dev}` | 開発サーバー起動 | | `{pnpm test}` | テスト実行 | | `{pnpm typecheck}` | 型チェック | | `{pnpm lint}` | Lint | | `{pnpm build}` | 本番ビルド | ## Project structure ``` {repo}/ ├── {apps/} # {アプリケーション} ├── {packages/} # {共有パッケージ} ├── {functions/} # {Cloud Functions} └── {docs/} # {ドキュメント} ``` ## Documentation - [Architecture](./docs/architecture.md) - [Contributing](./CONTRIBUTING.md) - [Deployment](./docs/deployment.md) ## License {MIT} © {Owner}

# {機能名} 技術仕様書 **Author**: {名前} **Status**: {Draft / In Review / Approved / Implemented} **Last updated**: {YYYY-MM-DD} **Reviewers**: {名前1, 名前2} ## TL;DR {3行で「何を、なぜ、どう作るか」} ## Background / Context {なぜこの機能が必要か。現状の問題点、ユーザーの声、ビジネス要求} ## Goals - {達成したいこと 1} - {達成したいこと 2} - {達成したいこと 3} ## Non-goals - {このスコープではやらないこと 1} - {このスコープではやらないこと 2} ## Proposed design ### 概要 {設計の全体像。図があれば挿入} ### データモデル ``` {スキーマ / 型定義} ``` ### API | Method | Path | Description | | --- | --- | --- | | POST | /api/{resource} | {作成} | | GET | /api/{resource}/:id | {取得} | ### フロー図 ```mermaid sequenceDiagram Client->>API: {リクエスト} API->>DB: {クエリ} DB-->>API: {レスポンス} API-->>Client: {レスポンス} ``` ## Alternatives considered ### 案A: {名前} - Pros: {メリット} - Cons: {デメリット} - 不採用理由: {理由} ### 案B: {名前} - Pros: {メリット} - Cons: {デメリット} - 不採用理由: {理由} ## Risks / Trade-offs - {リスク1とその緩和策} - {トレードオフ1} ## Rollout plan 1. {フィーチャーフラグ裏で実装} 2. {社内ドッグフード} 3. {{N}%ロールアウト} 4. {全量} ## Observability - メトリクス: {追加するメトリクス} - ログ: {追加するログ} - アラート: {新規アラート} ## Open questions - [ ] {未決事項 1} - [ ] {未決事項 2}

# ADR-{NNNN}: {決定事項のタイトル} **Date**: {YYYY-MM-DD} **Status**: {Proposed / Accepted / Deprecated / Superseded by ADR-NNNN} **Deciders**: {決定者の役割} **Tags**: {category1, category2} ## Context {この決定が必要になった背景。技術的な制約、ビジネス要求、組織状況など。「なぜ今、この決定を下す必要があるのか」を率直に書く} ## Decision We will {採用する技術 / アーキテクチャ / プラクティス} because {主要な理由}. 具体的には: - {決定の詳細1} - {決定の詳細2} - {決定の詳細3} ## Consequences ### Positive - {良い結果1} - {良い結果2} ### Negative - {悪い結果 / トレードオフ1} - {悪い結果 / トレードオフ2} ### Neutral - {副作用1} ## Alternatives considered ### {代替案A} - Pros: {利点} - Cons: {欠点} - 不採用理由: {理由} ### {代替案B} - Pros: {利点} - Cons: {欠点} - 不採用理由: {理由} ## References - {関連 ADR / Issue / 外部記事} - {ベンチマーク結果 / PoC リンク}

# Runbook: {アラート / 操作手順 名} **Owner**: {team / role} **Last verified**: {YYYY-MM-DD by @{name}} **Severity when fired**: {Sev1 / Sev2 / Sev3} ## このRunbookで対応するもの {どのアラート、どのインシデントタイプに対応するか} ## アラート発火条件 ``` {Datadog / Prometheus / Cloud Monitoring の条件式} ``` ## なぜこのアラートが重要か {放置するとどうなるか。ビジネス影響} ## 初動チェックリスト（5分以内） - [ ] ダッシュボード確認: {URL} - [ ] 直近のデプロイ確認: {URL} - [ ] 依存サービスのステータス確認: {URL} - [ ] エラーログ確認: {クエリ / リンク} ## 診断フロー ### 症状A: {例「APIレスポンスが5xxを返している」} 1. {確認コマンド} ```bash {kubectl logs / gcloud logging read など} ``` 2. {解釈方法} 3. → 緩和策A へ ### 症状B: {例「DB接続が枯渇」} 1. {確認コマンド} 2. → 緩和策B へ ## 緩和策 ### 緩和策A: {例「ロールバック」} ```bash {コマンド} ``` 所要時間: {N分} 影響: {一時的にどうなるか} ### 緩和策B: {例「水平スケール」} ```bash {コマンド} ``` ## エスカレーション - 30分で復旧の見通しが立たない場合: @{escalation-target} - データ損失の可能性がある場合: @{security-team} ## 関連リンク - ダッシュボード: {URL} - 過去のインシデント: {URL} - 関連 ADR: {URL}

## POST /api/{resource} {エンドポイントの目的を1行で} ### Authentication {Bearer token / API key / 不要} ### Rate limit {N req/min per user} ### Request **Headers** ``` Authorization: Bearer {token} Content-Type: application/json X-Idempotency-Key: {uuid} (optional, for retry-safe POST) ``` **Body** ```json { "{field1}": "{string, required, max 100 chars}", "{field2}": 0, "{field3}": [ { "key": "value" } ] } ``` ### Response **200 OK** ```json { "id": "{uuid}", "{field1}": "...", "createdAt": "2026-01-01T00:00:00Z" } ``` ### Errors | HTTP | Code | When | Recovery | | --- | --- | --- | --- | | 400 | INVALID_PARAM | {field}が不正 | 入力を修正してリトライ | | 401 | UNAUTHORIZED | tokenが無効 | 再認証 | | 403 | FORBIDDEN | 権限不足 | 管理者に問い合わせ | | 409 | CONFLICT | 重複作成 | 既存リソースを使用 | | 429 | RATE_LIMITED | 上限超過 | Retry-After ヘッダーに従う | | 500 | INTERNAL | サーバーエラー | リトライ可 | ### Example (curl) ```bash curl -X POST https://api.example.com/{resource} \\ -H "Authorization: Bearer $TOKEN" \\ -H "Content-Type: application/json" \\ -d '{"{field1}": "value"}' ```

## v{X.Y.Z} — {YYYY-MM-DD} {1〜2行のハイライト} ### :sparkles: 新機能 (New) - **{機能名}**: {ユーザーが何ができるようになったか}。詳細は[ヘルプ]({URL})。 - **{機能名}**: {説明} ### :wrench: 改善 (Improvements) - {改善内容}（{影響を受けるユーザー}） - {パフォーマンス: 例「リスト読み込みを2.1秒→0.4秒に短縮」} ### :bug: 修正 (Bug fixes) - {不具合内容}を修正しました（#{issue番号}） - {不具合内容}を修正しました ### :warning: 破壊的変更 (Breaking changes) - {変更内容}。{移行手順}。詳細は[マイグレーションガイド]({URL})。 ### :package: 内部変更（開発者向け） - {内部リファクタ} - {依存パッケージ更新} ### Known issues - {既知の問題}（次バージョンで対応予定） --- Full changelog: https://github.com/{org}/{repo}/compare/v{prev}...v{X.Y.Z}

# Welcome to {チーム名} :wave: {新メンバー名}さん、ようこそ！このドキュメントは、最初の30日でスムーズに立ち上がるためのチェックリストです。困ったらいつでも @{onboarding-buddy} に聞いてください。 ## Day 1（初日） - [ ] 各種アカウントの発行確認: {GitHub / Slack / 1Password / GCP} - [ ] 開発環境セットアップ: [docs/setup.md]({URL}) - [ ] リポジトリを clone してローカルで動かす: {repo URL} - [ ] 自己紹介を #general に投稿 - [ ] 1on1 を予定: {マネージャー / Buddy} ## Week 1（1週目） - [ ] アーキテクチャ概要を読む: [docs/architecture.md]({URL}) - [ ] プロダクトを実際にユーザーとして使ってみる - [ ] 「good first issue」を1つ完了して PR をマージ: {ラベルURL} - [ ] チーム定例に参加: {毎週X曜HH:MM} - [ ] 用語集を読む: [docs/glossary.md]({URL}) ## Month 1（1ヶ月目） - [ ] 中規模の Issue を1つ完了 - [ ] コードレビューを {N} 回担当 - [ ] オンコール見学に参加 - [ ] 30日振り返り 1on1: 改善提案を3つ持参 ## 連絡先・リンク - Slack: #{team-channel} / #help-{team} - ドキュメント: {URL} - インシデント対応: [docs/incident.md]({URL}) - カレンダー: {team calendar URL} ## 困ったとき - 技術的な質問: #help-{team}（誰でも気軽にどうぞ） - 人事・労務: @{HR担当} - 何でも雑談: @{onboarding-buddy} まずは焦らず、たくさん質問してください！