Markdown・Doxygen・Pandoc・PlantUML を組み合わせて、ソースコードから高品質なドキュメントを自動生成する方法を学びます。
ドキュメントをコードと同じリポジトリで管理することで、常に最新の状態を維持できます。
| スキルガイド | 内容 |
|---|---|
| Markdown | ドキュメント記法の基礎 |
| Doxygen | C/C++ ソースコードからのドキュメント生成 |
| Pandoc | Markdown から HTML/docx への変換 |
| PlantUML | テキストベースの UML 図表作成 (第 1 選択) |
| Mermaid | テキストベースの図表作成 (第 2 選択) |
| draw.io | GUI による任意の図作成 (第 3 選択) |
本フレームワークでは PlantUML・Mermaid・draw.io のすべてを扱うことができます。意味論を明確に表現しやすいことから PlantUML を第 1 選択とし、次いで Mermaid、任意のレイアウトの図が必要な場合にのみ draw.io の使用を推奨します。既存の PNG 等の画像ファイルも Markdown に直接引用できますが、修正履歴の管理が困難なため限定的な使用とすべきです。
| ツール | 特徴 | 推奨ケース |
|---|---|---|
| PlantUML | UML の意味論を厳密に表現できる | シーケンス図・クラス図・コンポーネント図など (第 1 選択) |
| Mermaid | GitHub でネイティブ表示・記法が簡潔 | フロー図など、GitHub 上でのプレビューを重視する場合 (第 2 選択) |
| draw.io | GUI で自由に作図できる | UML の意味論で表現しにくい任意のレイアウトの図 (第 3 選択) |
| PNG/SVG など | 既存の画像をそのまま利用できる | 外部ツールで作成済みの図・スクリーンショットなど (第 4 選択) |
doxyfw/ - Doxygen ドキュメント生成フレームワーク (サブモジュール)docsfw/ - Markdown 発行フレームワーク (サブモジュール)Doxyfile.part.calc - C プロジェクト用 Doxygen 設定docs-src/ - ドキュメントソース (Markdown ファイル群)docs/ - 生成済みドキュメント (HTML)ドキュメント自動化を習得したら、ステップ 5 - 自動化・拡張 に進んでください。