Writing and Documentation

原稿執筆と研究記録

文書の役割を分ける

場所	主な読者	書く内容
README.md	利用者	構成、環境構築、主要コマンド、入口
AGENTS.md	コーディングエージェント	守るべき実装・実行ルールの正典
docs/	研究者・共同研究者	研究ログ、判断理由、データ由来、会議メモ
exp/*/README.md	実験を検証する人	各実験の目的、方法、結果、考察
Wiki	新規参加者	ワークフローの説明と横断的ガイド
draft/	論文読者	原稿、補足資料、参考文献

ディレクトリ構成やコマンドを変更した場合は、README.md と AGENTS.md を同時に更新します。判断の背景は docs/、個別実験の知見は実験 README に置きます。

研究ログと意思決定記録

docs/templates/ の雛形をコピーします。

• 研究ログ: docs/log-YYYY-MM-DD-<topic>.md
• 意思決定: docs/decision-NNN-<slug>.md

研究ログには、その日に試したこと、結果、未解決点、次の一手を書きます。意思決定記録には、選択肢、採用案、理由、影響、見直し条件を書きます。

原稿をコンパイルする

draft/ はホストの LuaLaTeX でコンパイルします。

cd draft
lualatex -interaction=nonstopmode main.tex

参考文献を更新した場合:

cd draft
lualatex -interaction=nonstopmode main.tex
bibtex main
lualatex -interaction=nonstopmode main.tex
lualatex -interaction=nonstopmode main.tex

生成された .aux、.log、.out、.pdf などは Git 管理外です。コンパイルエラーはログを手で隠さず、原因となる TeX または参考文献を修正します。

図表と本文を同期する

• 図表は result/ へコードから生成する。
• 軸ラベル、単位、統計量、サンプル数を生成コード側で定義する。
• caption に示した条件が params.py と一致することを確認する。
• 数値を本文へ転記する場合、生成元の表またはスクリプトを記録する。
• Supplementary の解析にも実験番号または生成スクリプトを割り当てる。

執筆のおすすめ順序

1. 研究質問と主要図表を確定する。
2. 実際のコードに基づいて Methods を書く。
3. 図表に沿って Results を書く。
4. 仮説、先行研究、結果の位置づけとして Introduction と Discussion を組み立てる。
5. Limitations、データ／コード公開条件、倫理、利益相反を確認する。
6. 別環境で解析と原稿を再生成してから投稿版を固定する。