技術文書サイトを作る
検索可能な文書と版管理を、普段の開発手順に組み込む構成です。
代表的な構成
唯一の正解ではなく、理解しやすい出発点です。
- 01
JavaScriptへ静的な型検査を加えるプログラミング言語。
- 02
ReactとMarkdownで文書サイトを作る静的サイト生成器。
- 03
状態に応じた画面をコンポーネントで組み立てるUIライブラリ。
- 04
GitHub リポジトリ内でワークフローを自動実行するCI/CD。
- 05
エッジネットワーク上で配信、セキュリティ、コンピューティング、データを提供するプラットフォーム。
なぜこの構成？
- Docusaurusは文書の階層、版管理、検索連携をまとめて扱える。
- MarkdownとGitを使うため、コード変更と同じ手順で文書をレビューできる。
- React部品を使えば、説明用の操作例を文書内へ埋め込める。
向かない場面
- 非開発者だけで頻繁に更新するなら、Git中心の編集手順が負担になる。
- 単純な数ページの説明には、版管理機能を含む構成が過剰になりやすい。
別ルートもある
- 製品サイトと文書を一体化するなら、Astroで同じ構成にまとめる。
- 編集画面を優先するなら、ContentfulなどのCMSから文書を配信する。