Skip to content

調査をしながら考察・戦略・検討内容を文書化するためのテンプレートリポジトリ(Quarto使用)

License

Notifications You must be signed in to change notification settings

dobachi/DeliberationTemplate

Repository files navigation

DeliberationTemplate

GitHub Pages License

Quartoを使用した考察・戦略・検討内容の文書化テンプレートリポジトリです。 調査をしながら得られた知見を基に、考察や戦略立案、検討内容を体系的に文書化します。

詳細な使い方はGitHub Pagesをご覧ください

特徴

  • 調査と考察の統合: 調査で得た知見を基に考察・戦略を文書化
  • 意思決定の記録: 検討過程と判断根拠を構造的に記録
  • 多角的分析: 複数の選択肢の比較検討をサポート
  • 高品質出力: HTML / PDF / EPUB対応
  • 参考文献管理: BibTeX統合
  • 自動化: GitHub Actions対応

ResearchTemplateとの違い

観点 ResearchTemplate DeliberationTemplate
目的 調査結果の報告 考察・戦略・検討の文書化
重点 事実の収集と整理 分析・判断・意思決定
成果物 調査報告書 検討文書・戦略文書
構成 調査方法→結果→考察 問題定義→選択肢分析→戦略→判断

クイックスタート

1. リポジトリの準備

# このリポジトリをfork/cloneまたはテンプレートから作成
git clone https://github.com/dobachi/DeliberationTemplate.git
cd DeliberationTemplate

2. 環境セットアップ(初回のみ)

# Git submoduleの初期化
git submodule update --init --recursive

Quartoの自動セットアップ(推奨):

scripts/setup.sh

3. 検討文書を作成

# テンプレートをコピー
cp templates/deliberation_template.qmd reports/my-deliberation.qmd

# エディタで編集
vim reports/my-deliberation.qmd

4. ビルド

# HTML + PDFでビルド
make report

# 成果物を確認
ls output/

5. 配布パッケージ作成(オプション)

# 検討文書をZIPパッケージ化(成果物 + ソース)
make package

# dist/に生成されます
ls dist/

基本コマンド

make help              # ヘルプ表示
make report            # 検討文書をビルド(HTML + PDF)-> output/
make examples          # サンプルをビルド(HTML + PDF)-> output/examples/
make package           # 配布パッケージ作成 -> dist/
make preview           # ライブプレビュー
make clean             # ビルド成果物削除

ドキュメント

要件

必須

推奨(PDF生成用)

  • LuaLaTeX(日本語PDF対応)
  • luatexja(日本語組版パッケージ)
  • Noto Sans CJK JP フォント(日本語対応)

プロジェクト構造

DeliberationTemplate/
├── templates/          # テンプレートファイル
├── reports/            # ユーザーの検討文書(あなたが作成)
├── examples/           # サンプル検討文書
├── sources/            # リソース(参考文献、図表)
├── output/             # ビルド成果物
└── dist/               # 配布パッケージ

AI指示書システム(オプション)

このプロジェクトはAI指示書システムをgitサブモジュールとして導入できます。

対応AIツール:

  • Claude Code(推奨)
  • Cursor
  • その他のAIコーディングアシスタント

使い方:

  • AIツールは自動的にCLAUDE.mdCURSOR.mdを読み込みます
  • プロジェクト固有の指示はinstructions/PROJECT.mdを参照
  • チェックポイント機能: scripts/checkpoint.shで作業履歴を記録

詳細はCLAUDE.mdを参照してください。

ライセンス

Apache-2.0

リンク

About

調査をしながら考察・戦略・検討内容を文書化するためのテンプレートリポジトリ(Quarto使用)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published