テンプレートライブラリ

.qmd / .md / .adoc実用雛形を文書の型ごとに揃えています。気に入った型をコピーして、内容を差し替えるだけで使えます。

すべてのページが同一サイトに統合され、見出し ID・目次・リンク・画像参照が同じルールで正規化されることを実例として確認できます。

フォーマットについて

フォーマット 変換経路 備考
.qmd quarto render で直接 HTML 化 コールアウト・mermaid・コード等が使える
.md quarto render で直接 HTML 化 シンプルな文書向け
.adoc asciidoctor → HTML → quarto へ統合 admonition・テーブル等のブロック構文

qmd テンプレート

開発系・運用系・ナレッジ系の雛形です。

ページ 用途
基本 basic.qmd あらゆるページの最小構成
手順書 playbook.qmd 定期作業・対応手順
運用手順 runbook.qmd オンコール・アラート対応
トラブルシューティング troubleshooting.qmd 症状 → 原因 → 対処
API 概要 api-overview.qmd API 全体の設計
API エンドポイント api-endpoint.qmd 1 エンドポイントの仕様
API スキーマ api-schema.qmd 入出力の型定義
設計メモ design-doc.qmd 実装前の設計共有
提案書 proposal.qmd 変更の提案・承認
調査ノート research-note.qmd 技術調査の記録
ハウツー how-to.qmd ゴール達成の手順
FAQ faq.qmd よくある質問
オンボーディング onboarding.qmd 新メンバー向け
ブログ記事 blog-post.qmd 読み物記事
技術レポート report.qmd 調査・計測の結果

md テンプレート

軽量で書ける型の雛形です。

ページ 用途
基本 basic.md .md の最小構成
応用 advanced.md 見出し・リンク・画像を組み合わせた応用
ADR adr.md アーキテクチャ決定記録
決定ログ decision-log.md 日々の決定の時系列記録
議事録 meeting-notes.md 会議の記録
読書ノート reading-notes.md 書籍・記事の記録
リリースノート release-notes.md リリースごとの変更
チェンジログ changelog.md 変更履歴
障害報告 incident-report.md 障害の記録・再発防止
週報 weekly-report.md 一週間の成果
進捗報告 status-report.md ステークホルダー向け現状報告
用語集 glossary.md 用語定義の一覧
チートシート cheatsheet.md 頻出操作の一覧
比較検討 comparison.md 選択肢の比較・結論

adoc テンプレート

AsciiDoc のブロック構文を活用する型の雛形です。出力は adoc-pages/ 配下に統合されます。

ページ 用途
基本 basic.adoc AsciiDoc の最小構成
手順書 playbook.adoc 手順書(qmd 版と同じ型)
API 概要 api-reference.adoc API 設計(テーブル構文)
議事録 meeting-notes.adoc 議事録(qmd 版と同じ型)
チートシート cheatsheet.adoc admonition・画像ブロックの見本

mdv テンプレート(参考)

以下は quarto-plus のパイプラインとは別系統の仕組みです。quarto-plus では常用しませんが、Markdown 単体でチャート・KPI・テーブルを持つ自己完結 HTML/PDF を生成したい場合の参考として収録しています。

ファイル 用途
基本 basic.mdv MDV の最小構成(KPI・棒・折れ線・テーブル)
ダッシュボード dashboard.mdv chart / stat / table / columns を組み合わせたフル構成

MDV の導入手順・書き方・制約は MDV とは(参考) を参照してください。また、.mdv.qmd の使い分けは .mdv と .qmd の詳細比較 を参照してください。

統合の確認ポイント

  • 各ページの見出しは pagePrefix-<slug> 形式の一意な ID を持ちます
  • すべてのページ上部に #toc の入れ子目次が生成されます
  • 画像は内容ハッシュ名で assets/ に集約されます
  • ページをまたぐリンクも自動で解決されます

関連