Home

research-template Wiki

この Wiki は、research-template を使って研究計画、データ処理、反復実験、図表生成、論文執筆までを再現可能に進めるための実践ガイドです。

まず読むページ

• クイックスタート — 新しい研究プロジェクトを立ち上げる
• 研究ワークフロー — 問いの設定から論文までの全体像
• 実験の進め方 — exp/NNN_<slug>/ を使った反復実験
• データ管理 — 生データ、派生データ、機微情報の扱い
• 再現性と品質管理 — 環境固定、テスト、結果の追跡
• 原稿執筆と研究記録 — LuaLaTeX、研究ログ、意思決定記録
• GitHubでの共同作業と安全運用 — PR、ブランチ保護、公開前確認

このテンプレートの基本原則

1. 1 リポジトリ = 1 研究プロジェクトとする。
2. data/raw/ は不変とし、派生データと結果はコードから再生成する。
3. 再利用する処理は src/、実行入口は scripts/、反復実験は exp/ に置く。
4. Python は Docker + uv、原稿はホストの LuaLaTeX で実行する。
5. 実験条件、実行方法、結果、判断理由をコードと Markdown の両方に残す。
6. main を直接更新せず、フィーチャーブランチと Pull Request を使う。

文書の正典

コマンドやディレクトリ構成など、リポジトリと常に一致すべき事実は README.md を参照してください。コーディングエージェント向けルールの正典は AGENTS.md です。Wiki は研究の進め方と判断の助けになる説明を担います。

公開リポジトリでは、コードだけでなく Git 履歴、Issue、Pull Request、Wiki も公開情報です。秘密情報、未公開データ、個人情報、契約上公開できない情報は置かないでください。