はじめに
ExcelやWordで作られている設計情報は参照しにくく、メンテもしにくい。先方の事情があるならともかく開発中に参照する資料をOffice製品で作るのは避けたいところ。
今回は静的サイトジェネレーターを使って、文字ベースの仕様や用語などの情報をドキュメント化しましょう。
やりたいこと
- 開発中に、開発の指針となる設計書をブラウザで確認したい
- 設計書の元になるソースはエディタで編集して、Gitで差分管理したい
- CI/CDで自動ビルド、自動デプロイまでしたい
まずは
設計書といっても種類があります。まずは比較的やりやすいと思われる「用語集」のテンプレートを作るところを目標にします。
で、hugo
色々あるようですが以下のような理由でhugoを採用。
- HTMLまたはMarkdownで書ける静的サイトジェネレーター
- テーマやテンプレートが豊富
- ビルド環境の用意が簡単（非公式のdocker版が公開されている）
- コミット頻度が比較的多い（hugo自体の開発が盛んである）
- Go言語で作られている
この辺まで調べてチャレンジすることに決定。
次回は使ってみた編。