Navigation ページは、ドキュメントの特定領域へ読者を案内するサブランディングです。本文はほぼありません。短い導入と、配下の子ページの自動生成一覧だけです。トーンは短く、実務的にします。
ドキュメントのある領域に子ページが多く、案内付きの入口が必要なときに Navigation ページを書きます。次のものではありません。
- Overview。 Overview は製品を紹介し、新規読者を本文で導きます。Navigation ページは、配下の子ページへの案内が主です。
- Concept。 Concept は仕組みを説明します。Navigation ページは説明せず、先へ案内するだけです。
全体の比較は コンテンツタイプ を参照してください。
- タイトル: そのページが入口となるセクションまたは領域の名前にします。読者が辿ってきた見出しと揃えます。
- 説明: その領域を案内し、子ページが扱う主なトピックを挙げます。
次の骨格をコピーし、対象領域に合わせて直します。
---
title: <セクションまたは領域名>
description: <領域> を案内します。<子ページが扱う主なトピック> を扱います。
pcx_content_type: navigation
sidebar:
order: 10
products:
- product-a
---
import { DirectoryListing } from "~/components";
領域を 1〜2 文で紹介し、一覧で子ページへ案内します。
<DirectoryListing />- DirectoryListing がページ本文の中心です。フォルダー配下の子ページをリンク一覧として表示し、ページの追加や削除に合わせて自動で更新されます。
- 載せないもの: 本格的な説明や手順。Navigation ページには独自のコンテンツを置かないので、説明はリンク先のページに書きます。
pcx_content_type: navigation
products:
- product-a
- product-b詳細は pcx_content_type を参照してください。
- 自動一覧。 手書きのリストではなく DirectoryListing を使い、エージェントが辿る経路が常に現在の子ページになるようにします。
- 孤立した本文を置かない。 説明や手順は Navigation ページに書きません。ここに着いたエージェントは読むのではなく、先へ案内される必要があります。
- 子ページのタイトルは単体で分かるように。 一覧には各子ページのタイトルだけが出ます。読者やエージェントが行き先を選ぶ手がかりはそれだけなので、タイトルは単独で意味が通るように書きます。