コンテンツにスキップ

ナレッジベース、立ち上げました

We部のナレッジベースを今日一日で作り上げました。「運営に質問が集中しないようにしたい」という課題意識が出発点です。NotebookLM に食わせることで、メンバーが自己解決できる仕組みを目指しています。

なぜ作ったか

コミュニティを運営していると、同じ質問が繰り返し来ます。「どうやって参加するの?」「活動ってどんな感じ?」「チームはどう決まるの?」——毎回答えるのは限界があるし、なにより運営側が情報の出口になっている状況は健全じゃない。

メンバーが自分で調べて解決できる仕組みが欲しかった。そのためのナレッジベースです。

今日やったこと

リポジトリ作成・MkDocs 環境構築

GitHub でリポジトリを作成し、MkDocs + Material テーマの環境を整えました。requirements.txt に依存関係をまとめ、Docker でも起動できるよう docker-compose.yml も用意。ローカル開発環境は mkdocs serve 一発で動きます。

GitHub Pages への自動デプロイ設定

GitHub Actions でCI/CDを構成しました。main ブランチにpushするたびに mkdocs gh-deploy が自動実行され、GitHub Pages に反映されます。手動デプロイは不要です。

コンテンツの作成

一番時間をかけたのはここです。今日書いたページは以下の通り:

  • トップページ(index.md):We部の概要・目的・参加方法をまとめた入口ページ
  • コミュニティについて(about.md):設立背景・理念・外部連携先(オプティム)など
  • 活動スケジュール(schedule.md):前期・後期チーム制作、デザインスプリント、ハッカソン等の年間スケジュール感
  • よくある質問(faq.md):メンバーが疑問に思いそうなことをQ&A形式で整理
  • 運営について(operations.md):運営体制・連絡手段・意思決定の流れ
  • 活動報告テンプレート:今後の活動報告をフォーマット統一するためのひな形

CLAUDE.md の作成

Claude Code 向けの設定ファイルを書きました。このリポジトリで AI アシスタントを使う際の方針(何を書くか・書かないか、NotebookLM を意識した構造など)を明文化しています。

細かい設定まわり

  • サイト言語を日本語に設定(language: ja
  • フォントの調整
  • 外部リンク(公式Webサイト、OBOGポータル)の追加
  • VSCode 推奨拡張機能の設定(.vscode/extensions.json
  • Blog プラグインの追加(この記事もその成果)

今後やりたいこと

ナレッジベースの土台はできました。あとは実際の活動を通じて中身を積み上げていくフェーズです。活動報告、議事録、メンバー向けのガイドなど、コミュニティが動くにつれてドキュメントも育てていく予定です。

NotebookLM との連携も具体的に進めていきたいと思っています。構想としては、main ブランチに変更が入ったタイミング(GitHub Actions が走るタイミング)で、docs/ 配下のファイルを自動的に Google ドライブに同期する仕組みを作ること。Google ドライブをソースとして NotebookLM に登録しておけば、ドキュメントを更新するだけでナレッジが自動反映される流れになります。


2026-04-12 追記:開発環境の整備

VSCode 保存時自動フォーマット

.vscode/settings.json に Markdown ファイルの保存時フォーマットを設定しました。ファイルを保存するたびに markdownlint が自動で走り、スタイルが統一されます。

一括フォーマット(Format Files 拡張)

VSCode の拡張機能 jbockle.jbockle-format-files を導入。コマンドパレットから「Start Format Files: Workspace」で全 Markdown ファイルを一括フォーマットできます。.venv/site/ など不要なディレクトリは除外設定済みです。

コミット前自動フォーマット(git hook)

git commit 時にステージングされた Markdown ファイルへ自動で markdownlint が走る仕組みを整えました。lefthook など外部ツールも検討しましたが、依存を最小限にするためシンプルな git hook(シェルスクリプト)を採用。.githooks/pre-commit をリポジトリに含め、以下のコマンドで有効化できます。

git config core.hooksPath .githooks

README にもセットアップ手順を追記しました。