コンテンツにスキップ

参照

目的

参照コンテンツの目的は、設定、値、またはオプションに関するさらなる学習のための補足情報を提供することです。参照情報はユーザーにとって役立ちますが、参照情報がユーザーのタスク完了を妨げたり、阻止したりしてはいけません。

トーン

平易で率直

content_type

reference

構造

必須コンポーネント

タイトル: 単一の参照ページの場合は、「参照」をタイトルとして使用します。子ページを持つ参照セクションの場合は、タイトルに名詞を使用します。例えば、一般的なCf-Polishedステータス

コンテキスト: このページの情報をユーザーがどのように、なぜ利用するかを説明する導入段落を提供します。

オプションコンポーネント

コードスニペット: APIレスポンスや特定のタスクを実行するためのコマンドの例。

動的リスト: フィールドの長いリスト(20以上)。

: 特定の構成やAPI呼び出しを参照するコードサンプル。

ノート/ヒント/警告: 概念を助けたり簡素化したりするための関連情報や、ユーザーに潜在的な影響を警告する情報。

スクリーンショット: 複雑なタスクの完了した構成の画像。

テーブル: 機能の長いリストと関連する数値または用語とその定義。

キャッシュ: 一般的なCf-Polishedステータス

Logpush: Logpush API構成

テンプレート

単一の参照ページ

---
weight: xx
pcx_content_type: reference
---
# 参照
このページの参照情報の概要を書いてください。このセクションに子ページがある場合は、DirectoryListingスニペットを使用して、各子ページへのリンクを箇条書きで追加します。
<DirectoryListing path="/reference"/>
## 簡潔な名詞タイトル
このセクションのコンテンツの簡潔な説明。
## 簡潔な名詞タイトル
このセクションのコンテンツの簡潔な説明。