Company AI OS開発日誌 DAY6｜GitHubのdocsフォルダを整備する
はじめに
Company AI OSは、100日かけてAI企業を完成させるプロジェクトです。
このシリーズでは、完成したシステムを紹介するのではなく、設計から実装、試行錯誤までをすべて記録しています。
今回は、GitHubリポジトリの「docs」フォルダを整備し、プロジェクトを第三者にも分かりやすく公開できる状態を目指しました。
なぜdocsフォルダが必要なのか
開発者はソースコードを読むことに慣れていますが、初めてプロジェクトを見る人にとっては、どこから見ればよいのか分かりません。
そこで重要になるのが「docs」フォルダです。
このフォルダには、プロジェクトの概要や設計思想、ディレクトリ構成、開発手順などをまとめます。
コードだけでは伝わらない「なぜこの設計にしたのか」を文章として残すことで、プロジェクト全体の理解が深まります。
今回行った作業
今回実施した内容は次のとおりです。
docsフォルダを作成
READMEとの役割を整理
GitHub上で公開するドキュメント構成を設計
今後追加する設計資料の整理
この土台を整えることで、開発が進んでも情報を体系的に管理できるようになります。
Company AI OSではドキュメントも資産になる
AIシステムはコードだけでは完成しません。
設計思想や構成、運用方法まで含めて初めて再利用可能なシステムになります。
Company AI OSでは、
YouTubeで開発の様子を公開
noteで設計思想や技術解説を共有
GitHubでコードとドキュメントを管理
という3つの媒体を連携させながら、一つのプロジェクトを育てています。
今日の学び
docsフォルダは単なる資料置き場ではありません。
プロジェクト全体の知識を蓄積し、将来の自分や他の開発者が迷わず理解できるようにするための重要な基盤です。
Company AI OSは100日でVersion 1.0の完成を目指しています。
その過程で積み重ねたドキュメントも、プロジェクトの大切な成果物になっていきます。
次回予告
次回は、Company AI OSの共通ライブラリをさらに整備し、AI社員全体で利用できる基盤づくりを進めます。
100日後に完成する「AI企業」を目指して、これからも一歩ずつ開発を続けていきます。
