# General Translation Blog: 人間のためのドキュメント設計
URL: https://generaltranslation.com/ja/blog/designing-docs-for-humans.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: AIの時代にもデザインが重要であり続ける理由と、頭の中の混乱を整理するために私たちが掲げるドキュメント設計の原則。
Authors: Kevin Liu, Taylor Fang
Published: 2026-09-17

## なぜドキュメントをデザインするのか？

ドキュメントは、Webデザインにおける未解決の課題です。パターンとアンチパターンがいたるところに存在し、既成のテンプレートを通じて無限に複製されています。テンプレートは手早く簡単ですが、ドキュメントを、特定のユーザーに向けてデザインすべき製品体験の中核ではなく、後付けのものとして扱ってしまう危険があります。また、定番とされる選択肢は、視覚効果によって過剰にデザインされていることもよくあります。ドキュメントサイトに必要なのは**コンテンツに集中できる、よりシンプルな読む体験**であり、凝ったデザインはマーケティングサイトに任せるべきだと私たちは考えています ([Fumadocsの作者](https://generaltranslation.com/blog/fuma-nama)の哲学に倣っています) 。

しかし、エージェントがドキュメントの読み手、そして書き手の大半を占める世界において、**それでもドキュメントサイトをデザインすべきなのでしょうか？** そもそもなぜ、人間にとっての読みやすさや視覚的なデザインに労力を割く必要があるのでしょうか？

AIによる粗製乱造コンテンツがあふれる世界だからこそ、直感的で意図の込められたドキュメントのインターフェースはいっそう重要になる、と私たちは考えています。この考えは、デザインという営みへの愛着と、自分たちの製品体験へのこだわりから来ています。しかしそれだけでなく、**人間は今なおドキュメントを見て読んでいる**という観察にも基づいています。確かにエージェントはコードを大量に実行しますが、単純な量の統計がすべてを物語るわけではありません。人間は今も、製品を理解し評価するためにドキュメントサイトを訪れます。そして人間はますます、頭の中の混乱を整理し、重要なことへ注意を向けさせてくれるインターフェースを必要としています。

私たちはドキュメントの再デザインをゼロから進め、[コンテンツの書き換え](https://generaltranslation.com/blog/rewriting-our-docs)で探求した並行するユーザージャーニーを出発点としました。ドキュメントのプリミティブはごくわずかです。ナビゲーション、検索、コントロール、リンク、そしてコンテンツ。これらを、線を減らし余白を広く取って配置することで、すっきりとした視覚体験を実現し、最大限のコンポーザビリティを得るためにオープンソースのドキュメントフレームワーク[Fumadocs](https://generaltranslation.com/blog/fuma-nama)を土台としました。

私たちは文章に多大な労力を注いでおり、それを読んでもらいたいと考えています。読む体験を滑らかに、さらには心地よいものにするドキュメントサイトをデザインし、維持し続けることが私たちの変わらぬ目標です。その過程で、いくつかの中核的なデザイン原則が生まれました。その第一は、親しみやすく理解しやすいインターフェースを採用することです。

![ページの全体像：4つのゾーンを青で示したIntroductionページのワイヤーフレームと、ナビゲーション、リンク、設定、アクション、テーマ切り替え、目次レール、コンテンツカードの実際の切り抜きを、それぞれの配置場所に対応させて示した図](/static/blogs/designing-docs-H0-cover-final.webp?v=20260920-0930)

## 直感的な流れと方向性

ドキュメントは、ユーザーが製品とその仕組みについてのメンタルモデルを構築する手助けとなります。これはドキュメントコンテンツの再構成についてのブログ記事で[以前述べた](https://generaltranslation.com/en-US/blog/rewriting-our-docs)とおりです。今回のデザインも、同じ中核的な思考原則から生まれています。すなわち、意図的で意味のある構成、段階的に明かされる複雑さとカスタマイズ性、そして邪魔にならず、いっそ見えないとさえ感じられるディテールです。

画面の各領域は**ひとまとまりのアクションや出力に対応しており**、ユーザーが「ここにあるはず」と思う場所に機能が現れます。 (一部のユーザーは視覚テーマに強いこだわりがあると分かったため、モード切り替えは2か所に配置しています。)

![4つのゾーンが示された新しいドキュメントのIntroduction ページ：左にナビゲーション、右上にアクション、左下にリンクと環境設定](/static/blogs/designing-docs-A1-zones-overlay.webp?v=20260920-0930)

さらにページ全体が直感的な流れをつくり、**ユーザーを目的の達成へと導きます**。

![トーンを抑えたページ上に番号付きの経路：把握する、移動する、読む、選ぶ、実行する](/static/blogs/designing-docs-A4-reading-path.webp?v=20260920-0930)

ドキュメントでは、更新情報を確認するためのChangelog、サポートへの質問、製品デモの申し込みなど、ユーザーが取りたくなるアクションへのリンクを目立たせています。

## 思考の雑然さを取り除く

インターフェースはますます雑然としてきています。「アイブロウテキスト」のような要素、複数の方向に動く脈絡のないアニメーション、 (角が丸い) 余計なボックス——こうしたものはAIによるデザインの典型的な兆候です。**この視覚的な雑然さは、そのまま思考の雑然さにつながります。** 各コンポーネントが、配置や他のコンポーネントとの関係を考慮されないまま、ただ存在するためだけに置かれているとき、意味は失われます。

そこで私たちの最初の仕事は、**思考の雑然さを削ぎ落とす**ことです。つまり、余計な要素を削除すること。今回の場合は、多くの余分な線、リンク、ボタンを削ることでした。

![削除した要素が赤で示された旧ドキュメントページ：検索フィールド、GitHubバナー、サイドバーのトグル、ヘッダーの罫線](/static/blogs/designing-docs-B1-redline-pass.webp?v=20260920-0930)

<Carousel label="削除したもの" width="3840" height="2160">
  <CarouselItem src="/static/blogs/designing-docs-B2-before-after-split.webp?v=20260920-0930" alt="同じ縮尺で並べた旧・新のIntroductionページ。削除部分は赤、置き換えた行は青で表示" />

  <CarouselItem src="/static/blogs/designing-docs-B5-header-strip.webp?v=20260920-0930" alt="旧・新の上部帯と、各コントロールの行き先を示す線：検索フィールドは⌘Kアイコンへ、GitHubバナーはスターのピルへ、サイドバーのトグルは削除" />
</Carousel>

しかしそれは同時に、構造化し、再編成し、徹底的に簡素化することでもあります。とりわけ私たちは、**サイトを構成する概念を整理し、その所在を示す**地図として、ナビゲーションのサーフェスを統合しました。

![旧ページと新ページのそれぞれで、すべてのナビゲーションサーフェスを枠線で示した図](/static/blogs/designing-docs-C1-nav-census.webp?v=20260920-0930)

私たちのサイドバーは、いまや単一のアコーディオンです。革命的には聞こえないかもしれませんが、これはドキュメントサイトでは希少な存在になっています。多くのサイトは、縦にも横にも、複数の場所に複数のセクションナビゲーションバーを表示しているからです。

<Carousel label="単一のアコーディオン" width="3840" height="2160">
  <CarouselItem src="/static/blogs/designing-docs-C2-accordion-anatomy.webp?v=20260920-0930" alt="拡大した新しいサイドバー。セクション切り替え、アクティブ項目、グループ見出し、フッターリンク、環境設定にラベルを付け、その先の2つの階層（開いた切り替え内のセクションと、目次レールの見出し）を並べて表示" />

  <CarouselItem src="/static/blogs/designing-docs-C5-one-tree.webp?v=20260920-0930" alt="4つのグループと23ページからなるツリーとして描いたサイドバーを、実際のサイドバーに対応付けた図" />

  <CarouselItem src="/static/blogs/designing-docs-C4-sidebars-side-by-side.webp?v=20260920-0930" alt="同じ縮尺で並べた旧・新のサイドバーと、その違いを示すラベル" />
</Carousel>

CIはサイドバーの明確な階層を強制し、すべてが同じ階層に並ぶ気の遠くなるようなリンクとオプションの羅列になることを防ぎます。しかも、その状態は保たれます。リンクをクリックしてもサイドバーのオプションが丸ごと入れ替わったり、戻ろうとしたときに自分の居場所を見失ったりすることはありません。

## 視線を導く

直感的な導線は、インターフェースの中をどう進めばよいかをユーザーに教えてくれるものでもあります。ナビゲーション、コントロール、コンテンツ、アクションのそれぞれで**視覚的な階層をより明確に打ち出すこと**により、重要な箇所へ自然に視線が向かうようにしたいと考えました。

a) 重要な箇所にアイコンを使い、文字びっしりの画面に切れ目をつくる。

![旧ドキュメントの段落とリンクのリストと、新ドキュメントのAboutセクションを並べたもの：3枚のカードがあり、それぞれ塗りつぶしアイコンが先頭に置かれている](/static/blogs/designing-docs-D3-icons-not-lists.webp?v=20260920-0930)

b) テキストのセクション間に区切りを増やし、コンテンツをまとめてセクションの切れ目をはっきりさせる。

![Introductionページ上部。2本の1pxの罫線と要素間の余白が計測されている](/static/blogs/designing-docs-D4-rules-and-space.webp?v=20260920-0930)

c) テキストのスタイルに強弱をつける。ドキュメントでは敬遠されがちなイタリック体を使ったり、本文のウェイトを400に下げたりする。

![ページから実際の文字組みを拡大し、役割ごとにラベル付けしたもの：見出し、要約、イタリックのメタ情報、補足、グループ見出し](/static/blogs/designing-docs-D1-type-specimen.webp?v=20260920-0930)

とりわけ、[Linearのドキュメント](https://linear.app/docs)に着想を得て、コンテンツにゆとりを持たせる余白をたっぷり取りたいと考えました。Quickstartsページのリニューアルは、これらの原則を組み合わせた好例と言えるでしょう。

![IntroductionページのQuickstartsセクションのビフォーアフター：コマンドラインの下に8つのロゴタイルが並んでいたものが、アイコンと名称と1行の説明を持つ8枚のカードになっている](/static/blogs/designing-docs-D5-quickstart-pages.webp?v=20260920-0930)

## GT ならではの遊び心

ドキュメントサイトもウェブページである以上、無機質であってはなりません。過剰なデザインでコンテンツへの集中を妨げないよう注意しつつ、GT のブランドの美意識と世界観にドキュメントを馴染ませるため、「マイクロ UI」的なディテールも加えました。

[Fumadocs の象徴的な目次コンポーネント](https://generaltranslation.com/en-US/blog/fuma-nama/#the-fumadocs-design-credo)には、さりげないインタラクションを作り込みました。SVG マスクとしてサーバーサイドレンダリングでも動作し、12px のネストレベルと、ポインターを追う淡いブルーのつまみを備えています。モバイルのドロワーでは同じ形状を静的に描画します。タッチにはホバーがないためです。

![ページのスクロールに合わせて動くドキュメントの目次: ブルーのつまみがレール上を滑って現在の見出しへ移動する](/static/blogs/designing-docs-toc-slide.gif?v=20260920-0930)

同じマスクをサイドバーにも適用しました。あるセクションを上から下までクリックしていくと、ブルーのつまみがレールに沿って滑り、ツリーがネストする箇所では内側へ曲がりながら、行ごとにポインターを追いかけます。

![React リファレンスのサイドバー: ホバーのピルがツリーを下りながらポインターを追い、ページをクリックするたびにブルーのつまみが曲がり角を通ってレール上を進む](/static/blogs/designing-docs-sidebar-mask.gif?v=20260920-0930)

AI っぽいデザインの兆候を打ち消すため、その他の UI プリミティブも吟味しました。アイコンが意味を担う箇所ではソリッドのアイコンを使い、検索やコピーといったコントロールには細いアウトラインの字形を残しています。ボックスの角丸も控えめにしました。スクロールバーは、ネイティブとオーバーレイが混在するデフォルトの状態をやめ、サイドバー・コードブロック・メニューで統一しました。また、言語切り替え機能には旗の絵文字ではなくカスタムの旗の SVG を使い、マットなビジュアルアイコノグラフィーを保ちつつランディングページと揃えています。

<Carousel label="UI プリミティブ" width="3840" height="2160">
  <CarouselItem src="/static/blogs/designing-docs-E2-solid-vs-outline.webp?v=20260924-1200" alt="新ドキュメントのアイコンのルール: コントロール（検索、言語、ページのコピー、テーマ）には細いアウトライン字形を、アイコンが意味を担う箇所（Core・CLI・インテグレーションのカード、Libraries の機能、Changelog と Contact のリンク）にはソリッド字形を使う" />

  <CarouselItem src="/static/blogs/designing-docs-E3-corners.webp?v=20260920-0930" alt="旧来のピル型ボタンと検索フィールドを、新しいボタンとコピー用コントロールと同じ縮尺で並べ、その横にピルに取り消し線を引いた角丸スケールを示した図" />

  <CarouselItem src="/static/blogs/designing-docs-E7-quiet-scrollbar.webp?v=20260920-0930" alt="透明なトラック上に細い角丸のスクロールバーのつまみを備えたサイドバーと、そのつまみの拡大図" />

  <CarouselItem src="/static/blogs/designing-docs-E4-micro-ui.webp?v=20260920-0930" alt="カスタムのマットな SVG 旗を使った言語メニューと、同じ一覧を旗の絵文字で描いたもの" />
</Carousel>

そしてもちろん、私たちのドキュメントのローカライゼーション体験は最高水準でなければなりません。余白も揃えも順序も、そのまま保ちます。

![同じ縮尺で並べた英語版と中国語版の Introduction ページ。破線のガイドが揃いを示している](/static/blogs/designing-docs-E5-localized.webp?v=20260920-0930)

## やってはいけないことリスト

この取り組みを進める中で、気づいたアンチパターンをまとめた「やってはいけないことリスト」ができあがりました。

* アイブロウテキスト
* 脈絡のない余計な説明文
* 角を丸めすぎたボックス
* 塗りつぶしになっていないアイコン
* コンテンツの重要度と対応していない不揃いな余白
* ローカライズされていないドキュメント (！)
* ページ内に散在する複数のナビゲーション要素
* 無限に広がっていくように見えるサイドバー
* 何かをクリックするたびに中身が変わるサイドバー
* 今どこにいるのか分からなくなるサイドバー

<Carousel label="やってはいけないことリスト" width="3840" height="2160">
  <CarouselItem src="/static/blogs/designing-docs-F2-spot-the-antipatterns.webp?v=20260924-1200" alt="5つのアンチパターンに赤で番号が振られた、一般的なドキュメントカードの例示モック" />

  <CarouselItem src="/static/blogs/designing-docs-F5-poster.webp?v=20260920-0930" alt="ごちゃつき、ナビゲーション、言語に再分類され、各項目に赤いバツ印が付けられたやってはいけないことリスト" />
</Carousel>

もちろん、私たちはドキュメントのデザインを継続的に改善し続けています。ご意見・ご感想はいつでも歓迎です。よいドキュメントデザインを！

## Sitemap

See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.
