ResearchTemplate
調査報告書作成テンプレート - 使い方ガイド
1 概要
このプロジェクトは、Quartoを使用した調査報告書作成のテンプレートリポジトリです。 高品質な調査報告書を効率的に作成するためのツールとワークフローを提供します。
Tipサンプルも使い方ガイドです
技術動向調査報告書は、Quartoの各種機能（数式、図表、参考文献等）の実例を示すサンプルであり、同時にQuartoの使い方を学べるガイドとしても機能します。
2 特徴
- 📝 シンプル: Markdown記法で簡単に記述
- 🎨 高品質: プロフェッショナルなデザイン
- 📚 多様な出力: HTML / PDF / EPUB対応
- 🔗 参考文献管理: BibTeX統合
- 🤖 自動化: GitHub Actions対応
- 📦 配布機能: 報告書をZIPパッケージ化
3 クイックスタート
3.1 1. リポジトリの準備
# このリポジトリをfork/cloneまたはテンプレートから作成
git clone https://github.com/dobachi/ResearchTemplate.git
cd ResearchTemplate3.2 2. 報告書を作成
# テンプレートをコピー
cp templates/report_template.qmd reports/my-research.qmd
# エディタで編集
vim reports/my-research.qmd3.3 3. ビルド
# HTML + PDFでビルド
make report
# 成果物を確認
ls output/3.4 4. 配布パッケージ作成
# 報告書をZIPパッケージ化（成果物 + ソース）
make package
# dist/に生成されます
ls dist/4 ディレクトリ構造
ResearchTemplate/
├── templates/ # テンプレートファイル
│ ├── report_template.qmd
│ └── styles/
├── reports/ # ユーザーの報告書（あなたが作成）
│ └── .gitkeep
├── examples/ # サンプル報告書
│ └── technology-survey.qmd
├── sources/ # リソース
│ ├── references/ # 参考文献（.bib）
│ └── diagrams/ # 図表ソース
├── output/ # ビルド成果物
├── dist/ # 配布パッケージ
└── Makefile # ビルドツール5 基本コマンド
make help # ヘルプ表示
make report # 報告書をビルド（HTML + PDF）
make package # 配布パッケージ作成
make preview # ライブプレビュー
make clean # ビルド成果物削除6 ワークフロー
6.1 開発フロー
# 1. テンプレートをコピー
cp templates/report_template.qmd reports/my-research.qmd
# 2. ライブプレビュー開始
make preview
# ブラウザで http://localhost:xxxx が自動で開きます
# 3. my-research.qmdを編集
# 保存すると自動的に再ビルド＆ブラウザ更新
# 4. 最終ビルド
make report6.2 配布フロー
# 1. ビルド（まだの場合）
make report
# 2. パッケージ作成
make package
# 3. 配布
# dist/research-report-YYYYMMDD.zip を共有7 プロジェクト設計
7.1 テンプレートと報告書の分離
- templates/ = テンプレートファイル（リポジトリに含まれる、コピー元）
- reports/ = ユーザーの報告書（git管理外、ローカル作業用）
- examples/ = サンプル（GitHub Pages表示用）
7.2 パッケージの内容
make packageで作成されるZIPには以下が含まれます：
- formats/ - 成果物（HTML/PDF/EPUB）
- sources/ - 報告書ソース（.qmd）
- references/ - 参考文献（.bib）
- diagrams/ - 図表ソース
- README.md - パッケージの説明
テンプレートやビルドツールは含まれません（報告書配布のため）
8 GitHub Actions
mainブランチへのpush時に自動実行：
- examples/とindex.qmdをビルド
- GitHub Pagesにデプロイ
ユーザーの報告書（reports/）は各自のforkでビルドします。
9 要件
9.1 必須
- Quarto 1.3以上
9.2 オプション（PDF生成用）
- XeLaTeX
- Noto Sans CJK JP フォント（日本語対応）
9.3 インストール例（Ubuntu/Debian）
# Quarto
wget https://github.com/quarto-dev/quarto-cli/releases/download/v1.4.549/quarto-1.4.549-linux-amd64.deb
sudo dpkg -i quarto-1.4.549-linux-amd64.deb
# LaTeX + フォント（PDF生成用）
sudo apt-get install texlive-xetex fonts-noto-cjk10 技術スタック
- Quarto: 科学技術出版システム
- Markdown: 軽量マークアップ言語
- LaTeX: 数式・PDF生成
- BibTeX: 参考文献管理
- Make: ビルド自動化
- GitHub Actions: CI/CD