「社内だけ Git、配布は PDF」開発チーム向けドキュメントフロー

PM・エンジニア向け。Git(Markdown)で仕様管理→タグ付きコミットからPDF生成という社内ドキュメントフロー。レビュー・承認・配布・版管理・機密対応まで実務チェックリスト付き。

想定する読者とシーン

次のようなチームを想定しています。

共通の悩みは、「社内では Git で十分だが、顧客・営業・法務・他部署には PDF の方が通りやすい」というギャップです。この記事では、そのギャップを 運用で埋めるための型を整理します。


なぜ「Git」と「PDF」を分けるのか(担当別の見方)

観点Git(Markdown)PDF(配布物)
PM変更履歴と差分で「いつ何が変わったか」を説明しやすい締結・稟議・納品で 版が固定していることが重要
エンジニアPR レビュー・ブランチ戦略と相性がよい印刷・オフライン閲覧・レイアウト固定のニーズに応えやすい
社外ステークホルダーアカウントや Git の知識が前提になりがち添付ファイルとしてそのまま回せる

1 つのファイルに「執筆用」と「配布用の装飾」を詰め込むと、Markdown が肥大化し、レビュアーが本質の差分を読みにくくなることが多いです。執筆と履歴は Git読み手に渡す「顔」は PDF と役割を分けるのが現実的です。


ドキュメントの種類と置き場所(ざっくり分類)

運用を設計するときは、次のように 種類ごとに置き場所のルールを決めると迷子が減ります。

「全部 docs/README に書く」でも動きますが、チームが大きくなるほど フォルダで意味を分けるほうが、PM・エンジニアどちらからも発見しやすくなります。


ライフサイクル:草案 → レビュー → 承認 → タグ → PDF

ざっくり次の流れに揃えると、**「どれが公式版か」**が説明しやすくなります。

毎コミットで PDF を作り直す必要はありません。「この版が公式」というイベントで PDF を切ると、運用と説明の両方が楽です。


PM が押さえるとよいこと


エンジニアが押さえるとよいこと

CI で PDF を自動生成するチームもありますが、**まずは「タグを打った人がブラウザで PDF を切る」**でも十分運用できます。自動化はドキュメントが安定してからでよい、という割り切りも有効です。


配布用 PDF の命名と保管


ブラウザで PDF 化する意味(機密・コンプライアンス)

顧客名・未公開仕様・個人情報が含まれるドキュメントでは、クラウドの変換サービスに本文を送りたくないという要件が出ます。ブラウザ内で Markdown を読み込み、プレビューとレイアウトを確認してから PDF 保存する方式なら、ファイルがサーバーにアップロードされない前提で設計できます(本サイトのツールもその考え方です)。

社内規程で「利用できるツール」が決まっている場合は、セキュリティレビューに通しやすいという利点もあります。


うまくいかないとき

状況考え方
PDF ばかり増えて最新がわからないGit のタグ/リリースノートに「公式 PDF はこれ」と必ず書く
Markdown と PDF の内容が食い違うPDF はタグ付きコミットからのみ生成するルールにする
PM とエンジニアで認識がずれるPR で仕様の合意を取り、顧客向け PDF はマージ後だけに限定する
Git を使えないステークホルダーがいる草案は共有ドキュメントでもよいが、確定版は PDF+タグで固定する

リリース前チェックリスト(例)

次を満たしてから PDF を社外に出す、というチェックをチームでテンプレ化すると強いです。


まとめ

操作の細部は Markdown を HTML・PDF に変換する使い方・手順ガイド、改ページの調整は Markdown PDF の改ページを自分で決める方法 も参照してください。


関連記事