Skip to content

DIRECTORY_STRUCTURE.md

Latest commit

 

History

History
238 lines (210 loc) · 11.3 KB

DIRECTORY_STRUCTURE.md

File metadata and controls

238 lines (210 loc) · 11.3 KB

📁 AI開発のためのGitHubワークフロー実践ガイド - ディレクトリ構造

📊 プロジェクト概要

github-workflow-book/
├── 📖 メインコンテンツ (17章 + 6付録)
├── 🌐 GitHub Pages 設定
├── 📱 Kindle 出力準備  
├── 📝 Zenn Books 設定
├── ⚙️ 自動化スクリプト
└── 🔧 開発・メンテナンス用

📂 完全ディレクトリ構造

github-workflow-book/
│
├── 📚 **書籍メインコンテンツ**
│   ├── README.md                                    # 📖 メインインデックス・概要
│   ├── PUBLICATION_INDEX.md                         # 🔗 プラットフォーム統合ナビ
│   ├── introduction.md                              # 📑 はじめに
│   │
│   ├── 📖 **第1部：AI協働時代の基礎編**
│   │   ├── chapter-01-git-github-basics.md          # 第1章：Git・GitHub基礎
│   │   ├── chapter-02-ai-collaboration-fundamentals.md # ⭐ 第2章：AI協働基礎（核心）
│   │   ├── chapter-03-essential-commands-ai.md      # 第3章：コマンド＋AI活用
│   │   ├── chapter-04-github-collaboration-ai.md    # 第4章：協働作業AI版
│   │   └── chapter-05-account-repository-ai.md      # 第5章：アカウント管理AI版
│   │
│   ├── 🤖 **第2部：AIツール活用編**
│   │   ├── chapter-06-github-copilot-advanced.md    # 第6章：Copilot高度活用
│   │   ├── chapter-07-ai-code-review-practice.md    # 第7章：AIコードレビュー
│   │   └── chapter-08-github-advanced-security-ai.md # 第8章：セキュリティ＋AI
│   │
│   ├── 🔒 **第3部：セキュリティと権限管理編**
│   │   ├── chapter-09-access-permissions-ai.md      # 第9章：権限管理AI版
│   │   ├── chapter-10-organization-management-ai.md # 第10章：組織管理AI版
│   │   └── chapter-11-security-practice-ai.md       # 第11章：セキュリティ実践AI版
│   │
│   ├── ⚙️ **第4部：実践編（チーム開発）**
│   │   ├── chapter-11-practical-workflow.md         # 第12章：ワークフロー設計
│   │   ├── chapter-12-cicd-pipeline.md              # 第13章：CI/CD構築
│   │   ├── chapter-14-large-scale-data-model-ai.md  # 第14章：大規模データ管理
│   │   └── chapter-14-github-pages.md               # 第15章：Pages公開
│   │
│   ├── 🏢 **第5部：発展編（エンタープライズ対応）**
│   │   ├── chapter-15-external-collaboration.md     # 第16章：外部協力者連携
│   │   └── chapter-16-compliance-governance.md      # 第17章：コンプライアンス
│   │
│   └── 📚 **付録・参考資料**
│       ├── appendix-a-github-glossary.md            # 付録A：用語集
│       ├── appendix-b-troubleshooting.md            # 付録B：トラブルシューティング
│       ├── appendix-c-pricing-comparison.md         # 付録C：料金比較
│       ├── appendix-d-ai-cost-calculation.md        # 付録D：コスト計算
│       ├── appendix-e-git-aliases.md                # 付録E：Gitエイリアス
│       └── appendix-f-vscode-extensions.md          # 付録F：VS Code拡張
│
├── 🌐 **GitHub Pages 設定**
│   ├── _config.yml                                  # Jekyll設定
│   ├── docs/                                        # Pages用ディレクトリ
│   │   ├── index.html                               # ランディングページ
│   │   └── _includes/
│   │       └── navigation.html                      # ナビゲーション
│   └── assets/                                      # CSS・画像・JS
│       ├── css/
│       ├── images/
│       └── js/
│
├── 📱 **Kindle 出力**
│   ├── KINDLE_COMPLETE.md                           # Kindle統合版
│   └── kindle/                                      # Kindle出力用
│       ├── complete_book.md                         # 統合コンテンツ
│       ├── complete_book.html                       # HTML変換版
│       ├── book.opf                                 # Kindle設定
│       ├── convert_to_kindle.sh                     # 変換スクリプト
│       └── styles/
│           └── kindle.css                           # Kindle専用CSS
│
├── 📝 **Zenn Books 設定**
│   ├── ZENN_BOOK_CONFIG.md                          # Zenn設定ガイド
│   └── zenn/                                        # Zenn出力用
│       ├── package.json                             # Zenn CLI設定
│       └── books/
│           └── github-workflow-ai/
│               ├── config.yaml                      # 書籍設定
│               ├── cover.png                        # 表紙画像
│               └── chapters/                        # 章ファイル（30個）
│                   ├── 01-introduction.md
│                   ├── 02-part1-intro.md
│                   ├── 03-git-github-basics.md
│                   ├── 04-ai-collaboration-fundamentals.md
│                   └── ...
│
├── ⚙️ **自動化・スクリプト**
│   ├── scripts/
│   │   ├── publication_manager.py                   # 📤 出版管理スクリプト
│   │   ├── convert_to_zenn.py                       # 🔄 Zenn変換
│   │   ├── generate_kindle.py                       # 📱 Kindle生成
│   │   ├── validate_links.py                        # 🔗 リンク検証
│   │   └── ai_metrics_calculator.py                 # 📊 AI効果測定
│   │
│   └── .github/
│       └── workflows/
│           ├── publish.yml                          # 🚀 自動公開
│           ├── validate.yml                         # ✅ 品質検証
│           └── update-toc.yml                       # 📋 目次更新
│
├── 🔧 **開発・メンテナンス用**
│   ├── CLAUDE.md                                    # 🤖 Claude開発ガイド
│   ├── REMAINING_AI_UPDATES.md                      # 📝 残更新作業
│   ├── FINAL_AI_UPDATES_SUMMARY.md                  # 📊 更新完了サマリー
│   ├── DIRECTORY_STRUCTURE.md                       # 📁 このファイル
│   ├── github-workflow-book-toc.md                  # 📋 目次（master版）
│   │
│   ├── .gitignore                                   # Git除外設定
│   ├── LICENSE                                      # ライセンス（MIT）
│   └── CONTRIBUTING.md                              # コントリビューションガイド
│
└── 🎨 **アセット・リソース**
    ├── images/                                      # 画像素材
    │   ├── cover/                                   # 表紙デザイン
    │   ├── diagrams/                                # 図解・ダイアグラム
    │   └── screenshots/                             # スクリーンショット
    │
    ├── templates/                                   # テンプレート集
    │   ├── issue-templates/                         # Issue用
    │   ├── pr-templates/                            # PR用
    │   └── workflow-templates/                      # GitHub Actions用
    │
    └── examples/                                    # サンプルコード
        ├── ai-collaboration-metrics/                # メトリクス計測
        ├── clear-framework-examples/                # CLEARフレームワーク例
        └── security-patterns/                       # セキュリティパターン

🎯 ファイル重要度・役割

⭐⭐⭐⭐⭐ 最重要（必読）

  • README.md - プロジェクト全体の入り口
  • PUBLICATION_INDEX.md - プラットフォーム統合ナビ
  • chapter-02-ai-collaboration-fundamentals.md - 書籍の核心

⭐⭐⭐⭐ 高重要（実装・公開）

  • _config.yml - GitHub Pages設定
  • scripts/publication_manager.py - 出版自動化
  • .github/workflows/publish.yml - CI/CD

⭐⭐⭐ 中重要（プラットフォーム別）

  • KINDLE_COMPLETE.md - Kindle版マスター
  • ZENN_BOOK_CONFIG.md - Zenn設定
  • 各章ファイル（chapter-.md, appendix-.md）

⭐⭐ 低重要（メンテナンス）

  • CLAUDE.md - 開発履歴
  • *_UPDATES.md - 更新記録
  • アセット・リソースファイル

🚀 利用開始ガイド

📖 読者として

  1. PUBLICATION_INDEX.md で最適なプラットフォーム選択
  2. README.md で書籍概要を確認
  3. 第2章 から実践開始

👨💻 開発者として

  1. CLAUDE.md で開発経緯を理解
  2. scripts/publication_manager.py で出版準備
  3. GitHub Actions で自動化確認

🏢 組織利用として

  1. 第2章のCLEARフレームワーク をチーム標準に
  2. テンプレート を組織リポジトリに適用
  3. メトリクス でAI協働効果を測定

📊 統計情報

# 自動生成される統計（GitHub Actions）
- 総章数: 17章 + 6付録
- 総ファイル数: ~60ファイル
- 推定文字数: ~20万文字
- コード例: ~200例
- テンプレート: ~50種類

🔧 メンテナンス

📝 内容更新

# 1. 内容修正
vim chapter-XX-xxx.md

# 2. 自動検証
python scripts/validate_links.py

# 3. 全プラットフォーム更新
python scripts/publication_manager.py --platform all

# 4. Git管理
git add .
git commit -m "Update: [内容]"
git push

🔗 リンク管理

  • 内部リンクは相対パス使用
  • 外部リンクは定期的に検証
  • 画像パスはプラットフォーム別に最適化

📚 新章追加

  1. chapter-XX-new-topic.md 作成
  2. README.md の目次更新
  3. github-workflow-book-toc.md 更新
  4. Zenn・Kindle設定に追加

💡 Tips・ベストプラクティス

✍️ 執筆時

  • 第2章のCLEARフレームワーク を意識した構成
  • 具体例 を豊富に盛り込む
  • AI協働の実践 を必ず含める

🔄 更新時

  • 3つのプラットフォーム で一貫性を保つ
  • 読者フィードバック を定期的に取り込む
  • 最新のAI技術動向 を反映

📢 公開時

  • GitHub Pages で無料公開
  • Kindle で収益化
  • Zenn でコミュニティ構築

🤖 この構造も AI協働で設計されました
第2章のCLEARフレームワークを適用し、Claude、GitHub Copilot、ChatGPTとの協働により、効率的で保守性の高いプロジェクト構造を実現しています。