教材をコードとして扱う設計
教材、資産、設定、ビルドを同一リポジトリで進化させ、レビューとリリースを工程として組み込むDocs-as-Codeの発想。
cs249r_book は教材を“配布できるソフトウェア”として扱うリポジトリです。章はMarkdown/Notebookで管理し、ビルドは再現可能、差分はレビュー可能で、チームでの改善サイクルを回しやすい。ドキュメントをバラバラに置かず、Gitの流れに固定し、GitHub Pages などの静的配布で閲覧体験を安定させます。更新・正誤・翻訳も同じ工程で回せるため、教材が時間とともに腐るのを抑えられます。
| ✕従来の課題 | ✓革新的ソリューション |
|---|---|
| 教材が編集ツールやドライブ、チャットに散り、版管理・レビュー・ロールバックが効かず保守が重くなる。 | cs249r_book は教材をリポジトリ化し、章/資産/例をGitの工程へ統一して差分を管理可能にする。 |
| ビルド/公開の工程がない一発文書だと、体裁が崩れ、リンク切れや閲覧体験の差分が増える。 | Jupyter Book でビルドとテーマを標準化し、静的公開で“書く→ビルド→配布”を自動化しやすい形にする。 |
1git clone https://github.com/harvard-edge/cs249r_book.git && cd cs249r_book && python -m venv .venv1source .venv/bin/activate && pip install -U pip && pip install -r requirements.txt1jupyter-book build .1# _build/html/index.html を開く、またはローカルで配信して確認1# CIで _build/html を pages 用ブランチ/ディレクトリへ公開| コアシーン | 対象読者 | ソリューション | 成果 |
|---|---|---|---|
| 授業チームの保守可能な教材サイト | 教員/TA | 章、課題、正誤をリポジトリで協業 | レビューとロールバックが効き、公開が安定する |
| 社内研修の版管理された講義資料 | 研修担当 | 講義資料と例、読書ルートをサイト化 | 期ごとの差分が追えて一貫性が増す |
| 自習者向けのオフライン教材 | 自習者 | ローカルでビルドして閲覧 | サービス依存が減り、教材を長期保存できる |
