📄A LaTeX Template for Weekly Reports

進捗報告で使用するPDFドキュメントを生成するためのLaTeXテンプレートです．

本テンプレートを用いた報告資料の例 (内容は架空) はこちら:
https://github.com/b-sigpro/weekly-report/blob/main/example/build/report.pdf

👀目的

• 日常的にLaTeX文書を作成することで，論文・技術文書執筆の訓練を行う．
• 「概要・進捗内容・次にやること・予定」の4項目で構成され，読み上げるだけで円滑な報告を可能とする．
• LaTeX執筆・ビルド環境の構築コストを下げ，誰でも継続的に報告資料を作成できる環境を提供する．

📦インストール方法

1. Pixiの公式ガイド に従ってPixiをインストールする．

   • $HOME/.bashrc が更新されているので，ターミナルを開き直す．
   • Linux, macOS, WSL2等へのインストールをお勧めします．

2. 本リポジトリをcloneし，依存パッケージをインストールする．

   git clone https://github.com/b-sigpro/weekly-report/
   cd weekly-report/
   
   pixi install

3. VS Codeを用いて本リポジトリをワークスペースとして開く．

   code .

4. VS CodeにLaTeX Workshopをインストールする．

5. template/report.texをVS Codeで開き，氏名等の修正が必要な個所を修正する．

✍️使い方

1. template/フォルダをレポートの名前 (以降では例として 20261226/) へコピーする．

   cp -r template/ 20251226/

2. コピー先の report.tex をVS Codeで開く

   code 20251226/report.tex

3. VS Codeを用いて進捗を記述し，保存 (ctrl+s) する．自動で 20251226/build/report.pdf が生成される．

   • PDFの確認は，ctrl+alt+v を押せば埋め込みPDFビューワが起動する．

🎯注意点

• 各進捗では，目的を1文で簡潔にまとめる．
• 各進捗の最後に，結論として「完了か未完了か」「次のステップの有無」を示す．
• 実験・実装の結果は，目的に対して何が分かったかが伝わるよう記述する．
• 各文のつながりを意識し，論理的な矛盾や飛躍が生じていないか確認する．
• 図は可能な限りPDF等のベクタ形式を用いて可読性を確保する．

🙏謝辞

• 本テンプレートは Pixi Advent Calendar 2025 の寄稿をもとに作成されました．
  • pixi で ﾊﾝﾃﾞｨな TeX環境を作る
  • Ultra-light tex environment for AI proofread