ドキュメンテーション(ドキュメンテーション)
ソフトウェアやライブラリの仕様・使い方を文章化する作業や成果物。Mintlify / Docusaurus / VitePress / Nextra / GitBook / Confluence 等のツールが代表。
概要
ドキュメンテーション(Documentation)は、ソフトウェアやライブラリ・API・ハードウェア製品の仕様・使い方・トラブルシュート方法を文章化する作業や成果物を指す。優れたドキュメントはユーザー獲得とサポート工数削減を両立し、Stripe / Tailscale / Vercel / Anthropic 等の急成長企業は「ドキュメントが製品の一部」として徹底投資している。2026 年現在、Markdown ベースの静的サイトジェネレータ(VitePress / Nextra / Docusaurus)+ MDX による対話的サンプル + OpenAPI 自動生成 API リファレンスが主流である。
主要なドキュメントツール(2026 年)
静的サイトジェネレータ(OSS)
| ツール | フレームワーク | 特徴 |
|---|---|---|
| VitePress | Vue 3 + Vite | Vue 公式、軽量・高速、デフォルトテーマ美麗 |
| Nextra | Next.js 16 | Vercel 由来、MDX フル対応 |
| Docusaurus 3 | React + Meta | 大規模 OSS の定番、Versioning 強力 |
| Hugo Docsy | Hugo + Go | Google 採用、ビルド超高速 |
| Astro Starlight | Astro 5 | 軽量、静的サイト最速 |
| GitBook(v3 OSS) | 旧版 | レガシー、現行は SaaS |
SaaS 型
| ツール | 月額 | 特徴 |
|---|---|---|
| Mintlify | 無償〜$120 | Web Editor + AI Search、急成長 |
| GitBook(現行 SaaS) | $0〜$8/編集者 | チーム編集、Notion 風 UI |
| ReadMe | $99〜 | API ドキュメント特化 |
| Confluence | $5.16/ユーザー | Atlassian、企業内 Wiki |
| Notion | $10/ユーザー | 汎用、AI 機能強い |
API ドキュメント自動生成
| ツール | 形態 | 特徴 |
|---|---|---|
| Stoplight Elements | OSS | OpenAPI から自動生成、Web Component |
| Redocly Reference | OSS / Cloud | OpenAPI Spec 直結、業界標準 |
| Swagger UI | OSS | OpenAPI 公式リファレンス UI |
| Apidog | SaaS / Desktop | Postman 代替、ドキュメント生成統合 |
| Scalar | OSS | OpenAPI 美麗 UI、新興 |
主な内容構成
- Getting Started: 5 分でハンズオン、初学者の挫折を防ぐ
- Concept: 設計思想・用語定義
- API Reference: OpenAPI / GraphQL Schema から自動生成
- Tutorials: 段階的なチュートリアル群
- How-To Guide: タスク特化のレシピ集
- Troubleshooting: よくあるエラーと対処
- Changelog: バージョン履歴
- Migration Guide: メジャーバージョン移行手順
ベストプラクティス
- Diátaxis Framework: Tutorial / How-to / Reference / Explanation の 4 分類
- MDX 活用: 対話的サンプルコード、リアルタイム実行
- Code Block コピーボタン: ユーザー体験の基本
- Versioning: ライブラリのメジャーバージョン別ドキュメント保持
- Search: Algolia DocSearch(OSS なら無償)/ Mintlify AI Search
業界トップの事例(2026 年)
| 企業 / OSS | URL | 特徴 |
|---|---|---|
| Stripe Docs | docs.stripe.com | 業界最高峰、対話的サンプル |
| Anthropic Docs | docs.anthropic.com | Mintlify ベース、AI 関連最先端 |
| Tailscale Docs | tailscale.com/kb | 物語的解説、初学者に優しい |
| Vercel Docs | vercel.com/docs | Nextra、デザイン秀逸 |
| Cloudflare Docs | developers.cloudflare.com | Hugo Docsy、技術詳細網羅 |
| Linux Kernel Docs | kernel.org/doc | Sphinx + reStructuredText |
PC / 個人開発者の運用
- 個人 OSS / ポートフォリオ: VitePress + Vercel 無償枠(GitHub Pages も可)
- 副業 / SaaS スタートアップ: Mintlify 無償プラン → Pro $120/月
- API ドキュメント: Hono OpenAPI / FastAPI 等から自動生成 → Stoplight Elements 配信
- Markdown エディタ: Cursor / VS Code(Markdown All in One 拡張)
関連用語との違い
| 用語 | 違い |
|---|---|
| README | プロジェクト直下の入口、ドキュメンテーションは網羅的 |
| Wiki | 編集権限分散型、ドキュメントは権威的 |
| API リファレンス | API 限定、ドキュメントの一部 |
| Code Comment | コード内のインライン説明、ドキュメントは外部 |
よくある質問
Q1: VitePress と Nextra、個人 OSS で選ぶなら? A: Vue / Vite 派なら VitePress、React / Next.js 派なら Nextra。両者とも MDX 対応、デフォルトテーマ美麗、Vercel / Cloudflare で無償ホスト可能。
Q2: Mintlify は本当に無償で使える? A: 無償プラン(個人 / OSS)で機能制限版が永久無料。チーム編集 / カスタムドメイン / AI Search が必要なら Pro $120/月。
Q3: 2026 年の AI ドキュメント生成(Apidog AI / Mintlify AI Writer)は実用? A: 部分的に。OpenAPI Spec から定型文を生成は実用、ただしユースケース解説 / トラブルシュートは人手が必要。
まとめ
- ソフトウェアの 仕様・使い方文書化 全般
- 2026 年は VitePress / Nextra / Docusaurus / Mintlify が四強
- API ドキュメントは OpenAPI + Stoplight Elements / Redocly で自動生成