atomic-kanta-sasaki Documentation Skill
Overview
プロジェクトに必要な各種ドキュメントを作成します。
Document Types
| タイプ | 対象読者 | 内容 |
|---|---|---|
| README | 新規開発者 | プロジェクト概要、セットアップ |
| API Docs | API利用者 | エンドポイント仕様 |
| Architecture | 開発チーム | 設計思想、構成図 |
| Runbook | 運用チーム | 障害対応手順 |
| ADR | 将来の開発者 | 設計判断の記録 |
README Template
# プロジェクト名
簡潔な説明（1-2文）
## Features
- 機能1
- 機能2
## Tech Stack
- Backend: Node.js, Express, PostgreSQL
- Frontend: React, TypeScript
- Infrastructure: AWS, Docker
## Getting Started
### Prerequisites
- Node.js >= 18
- Docker & Docker Compose
- PostgreSQL 15
### Installation
\`\`\`bash
# リポジトリをクローン
git clone https://github.com/org/repo.git
cd repo
# 依存関係をインストール
npm install
# 環境変数を設定
cp .env.example .env
# データベースをセットアップ
docker-compose up -d db
npm run db:migrate
# 開発サーバーを起動
npm run dev
\`\`\`
### Environment Variables
| 変数名 | 説明 | 必須 |
|--------|------|------|
| DATABASE_URL | PostgreSQL接続文字列 | ✅ |
| JWT_SECRET | JWT署名キー | ✅ |
| REDIS_URL | Redis接続文字列 | |
## Development
### Commands
\`\`\`bash
npm run dev # 開発サーバー起動
npm run test # テスト実行
npm run lint # Lint実行
npm run build # ビルド
\`\`\`
### Project Structure
\`\`\`
src/
├── api/ # APIエンドポイント
├── services/ # ビジネスロジック
├── models/ # データモデル
├── utils/ # ユーティリティ
└── config/ # 設定
\`\`\`
## Deployment
本番デプロイ手順は [Deployment Guide](./docs/deployment.md) を参照
## Contributing
[Contributing Guide](./CONTRIBUTING.md) を参照
## License
MIT
ADR (Architecture Decision Record) Template
# ADR-001: タイトル
## Status
Proposed | Accepted | Deprecated | Superseded by ADR-XXX
## Context
この決定が必要になった背景と状況を説明。
## Decision
何を決定したかを明確に記述。
## Consequences
### Positive
- メリット1
- メリット2
### Negative
- デメリット1
- デメリット2
### Neutral
- 影響なしの変更点
## Alternatives Considered
### 案1: 代替案の名前
- 概要
- 採用しなかった理由
### 案2: 別の代替案
- 概要
- 採用しなかった理由
## References
- 関連ドキュメントへのリンク
Runbook Template
# Runbook: [インシデント/タスク名]
## Overview
このランブックの目的と対象となるシナリオ
## Prerequisites
- 必要な権限
- 必要なツール/アクセス
## Symptoms
このランブックを使用するトリガーとなる症状
- アラート名
- エラーメッセージ
- ユーザー報告内容
## Diagnosis
### Step 1: 状況確認
\`\`\`bash
# ログ確認
kubectl logs -l app=api --tail=100
# メトリクス確認
curl http://localhost:9090/api/v1/query?query=up
\`\`\`
### Step 2: 原因特定
確認すべきポイント:
- [ ] DBコネクション数
- [ ] メモリ使用率
- [ ] 外部API応答
## Resolution
### 対処法1: [軽度の場合]
\`\`\`bash
# Pod再起動
kubectl rollout restart deployment/api
\`\`\`
### 対処法2: [中度の場合]
手順を記載
### 対処法3: [重度の場合]
エスカレーション先と手順
## Verification
復旧確認方法
\`\`\`bash
# ヘルスチェック
curl https://api.example.com/health
\`\`\`
## Post-Incident
- [ ] インシデントレポート作成
- [ ] 根本原因分析
- [ ] 再発防止策検討
## Contacts
- Primary: @oncall-team
- Escalation: @platform-team
Changelog Template
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/),
and this project adheres to [Semantic Versioning](https://semver.org/).
## [Unreleased]
### Added
- 新機能
### Changed
- 変更
### Deprecated
- 非推奨
### Removed
- 削除
### Fixed
- バグ修正
### Security
- セキュリティ修正
## [1.0.0] - 2024-01-01
### Added
- Initial release