ドキュメント記事：既存ユーザー向けのバージョン管理されたリファレンス

ドキュメント記事とは、すでに製品、API、サービス、デバイス、または運用プロセスを使用している誰かのための保守されたリファレンスです。これは、設定の機能、フィールドが受け入れる値、必要なアクセス、このように動作するバージョン、または制限が適用される場所など、正確なルックアップ質問に回答し、読者に最初にマーケティングの議論を通過させることはありません。

その契約は、範囲 → 前提条件 → 現在の動作 → 正確なリファレンス → 例外 → 関連タスクです。ページは、ユーザーが適切なバージョンとロールに対して正しい事実を取得したときに成功します。すべてのインターフェースラベルを公開URLに変換しても役に立ちません。

回答する質問

主要な質問は次のとおりです：「この製品動作は、私のバージョンとコンテキストでは何を意味するのか？」 補足的な質問は次のとおりです：

• このページは私の製品、プラン、ロール、地域、プラットフォーム、バージョンに適用されますか？
• この機能を使用したり、このフィールドを参照する前に、何がすでに成立している必要がありますか？
• 受け入れられる値、デフォルト、制限、フォーマット、および副作用は何ですか？
• どの動作が現在のもので、以前のバージョンから何が変更されましたか？
• 重要な条件を隠さずにルールを示す例はどれですか？
• 手順、診断、または変更履歴が必要な場合、次に何を読むべきですか？
• この情報は公開検索で安全で有用ですか、それとも認証されたコンテキストが必要ですか？

この投稿タイプを使用するタイミング

1つの安定したページが繰り返しのルックアップをサポートする必要がある場合にドキュメントを使用します。対象には、権威ある所有者、テスト可能な動作、およびリリース、API、プラン、またはインターフェース変更などのメンテナンスシグナルが必要です。

「エクスポートフィールドの設定方法」というタイトルのページでも、その持続的な価値がフィールドカタログであり、ユーザーが個々のパラメータに直接ジャンプする場合は、依然としてドキュメントになり得ます。逆に、「最初のレポートをエクスポートする」は、読者が順序に従い、ダウンロードしたファイルを確認する必要がある場合にはハウツーです。タイトルの文法がフォーマットを決めるのではなく、読者のタスクと回答の形が決めます。

これらのビジネスタイプに最適

1. SaaS。 ロール、プラン、設定、統合、API、データモデル、リリースサイクルが正確なリファレンスニーズを生み出すため、最も適しています。ドキュメントはインターフェース動作とAPI動作、ユーザー権限とサブスクリプションエンタイトルメントを区別する必要があります。
2. Eコマース。 マーチャント管理、商品フィード、支払いルール、返品、統合、購入後の使用に適しています。ショッパーが実装リファレンスにたどり着かないよう、カスタマーヘルプとマーチャントドキュメントを分離します。
3. マーケットプレイス。 購入者、販売者、プロバイダー、管理者のロールによって異なる状態が表示される場合に適しています。同じラベルが異なるコントロールや義務を公開する可能性があるため、すべての記事は対象者を特定する必要があります。
4. エージェンシー。 クライアントポータル、デリバブル基準、反復ワークフロー、共有ツールに有用です。内部コントロール、認証情報、または独自の運用詳細を公開しない場合にのみ、再利用可能なクライアントリファレンスを公開します。
5. B2Bサービス。 オンボーディングシステム、データ引き継ぎ、ファイル仕様、承認状態、サービスポータルに有用です。条件がアカウントによって異なる場合に、契約上のコミットメントを一般的なヘルプセンターファクトとして提示することは避けます。
6. メーカーおよび工業企業。 コントロール、ソフトウェア、互換性、設定、メンテナンス記録、技術パラメータに価値があります。安全に関わる資料には、管理されたレビュー、明示的なモデル適用範囲、および権威あるマニュアルへの経路が必要です。

検索意図

検索意図とは、人がクエリから期待する結果です。ドキュメントの意図は通常、ナビゲーショナルとインフォメーショナルを組み合わせたものです：検索者は製品やオブジェクトを知っており、「Northstarエクスポート保持期間」「Northstarステータス値」「Northstar APIページサイズ」などの正確な事実を求めています。ブランド、機能、エラーのないタスク言語、バージョン、プラットフォームが一緒に現れることがよくあります。

理想的な結果は、回答に近い位置で開きます。説明的な見出し、安定したアンカー、受け入れられる値、バージョン修飾子を使用します。抽出されたステートメントはその条件を保持する必要があります：「TeamおよびEnterpriseプランでは、完了したエクスポートは30日間利用可能です。」

公開ドキュメントは、アカウントデータを明かさずに持続的な質問に回答する場合にランクされるべきです：サポートされているフォーマット、公開APIフィールド、互換性、制限、設定の意味、文書化された動作。

ドキュメントは、1つのUIラベルをミラーリングする場合、現在のページを複製する場合、継続的なニーズのない古いバージョンをカバーする場合、機密詳細を公開する場合、またはプライベートアカウントコンテキストが必要な場合にランクされるべきではありません。代わりに、認証されたヘルプ、アプリ内ガイダンス、noindex、統合、または明確なアーカイブ状態を使用します。検索需要が秘密やエクスプロイト経路の公開を正当化することは決してありません。

ページ構成

ワードバンドは制作上の目安であり、最小ノルムではありません。狭いフィールドリファレンスはより短くてもよく、バージョン管理された機能リファレンスは、適用範囲と例外がコストのかかるミスを防ぐため、より多くのスペースが必要になる場合があります。

ほとんどの本格的なドキュメント記事は1,500〜2,800語の範囲です。あいまいさを防ぐ場合にのみ詳細を追加します：範囲、前提条件、値、デフォルト、副作用、例外、またはバージョン変更。

必須要素

リファレンス読者はスキャンします。技術的に正しい値が誤ったプランやリリースに適用されないよう、リファレンスの前に適用範囲情報を配置します。

フロントマター

フロントマター仕様に従います。この投稿タイプ仕様では、entity = "post-type-documentation-article"です。制作されたドキュメントページでは、northstar-scheduled-export-settingsのような安定した製品オブジェクト値を、effortless-reportingのようなプロモーション用フレーズや、リリースごとに新しいIDを強制するバージョン番号ではなく使用します。

schemaType = "Article"を使用します。 スキーママークアップは表示されるページを説明する必要があります。1つの例に3つのアクションが含まれているという理由だけでHowToを選択しないでください。可視の質問と回答が正確に一致する場合にのみ、FAQ構造化データを追加します。APIリファレンスやソフトウェア固有のセマンティクスはサイトのデータモデルの他の場所で表現される可能性がありますが、より具体的なスキーマタイプをテンプレートサポートなしでフロントマターに発明するべきではありません。

メンテナンスシステムが強制できるフィールドを格納します：製品領域、プラン、ロール、プラットフォーム、バージョン範囲、検証日、所有者、置き換えURL。lastmodはタイプミスが修正されたのではなく、動作がレビューされたことを意味します。互換性のあるリリース間で正規URLを保持します。

完全な例

この架空の分析ダッシュボードの例は、リファレンスページを示すものであり、完全なエクスポート手順ではありません。

# スケジュールされたエクスポート設定

スケジュールされたエクスポートは、保存されたレポートからCSVまたはJSONファイルを固定UTC時刻に作成し、承認された宛先に配信します。TeamおよびEnterpriseプランのEditorおよびAdministratorロールが利用できます。このリファレンスはNorthstar Analytics Webアプリ6.4に適用され、2026年8月27日に検証されました。

## このリファレンスを使用する前に

既存の保存済みレポート、有効化された宛先、およびEditorまたはAdministratorアクセスが必要です。Viewerは既存のエクスポートをダウンロードできますが、スケジュールを作成または変更することはできません。宛先の管理者は追加の保持期間やファイルサイズ制限を課す場合があります。

## 設定リファレンス

| 設定 | 許容値 | デフォルト | 効果と制約 |
|---|---|---|---|
| 名前 | 1〜80文字 | レポート名 | スケジュールを識別します；変更しても以前のファイルの名前は変わりません。 |
| フォーマット | `csv` または `json` | `csv` | CSVはレポートの表示列順序を使用します。JSONは安定したフィールドキーを使用します。 |
| 実行時刻 | UTCの `HH:MM` | `08:00` | 夏時間の変更はUTC実行時刻を変更しません。 |
| 空の行を含める | オンまたはオフ | オフ | 表形式レポートでのみ利用可能；サマリーレポートでは無視されます。 |
| 保持期間 | 1〜30日 | 7日 | 既存のファイルは、それを作成したスケジュールとは独立して期限切れになります。 |

## 動作と境界

スケジュールは、実行開始時に保存されたレポート設定を読み取ります。したがって、レポートを編集すると将来のファイルは変更されますが、すでに生成されたファイルは変更されません。スケジュールを一時停止すると新しい実行は防止されますが、保持されているファイルは削除されません。宛先を削除すると配信が無効になり、スケジュールは「注意が必要」状態になります。

## 例

標準時のブラチスラバで09:00に必要な日次CSVの場合、UTC実行時刻を`08:00`に設定します。スケジュールはUTCに固定されたままであるため、夏時間ルールが変更されたら時刻を見直してください。

無効な例：実行時刻フィールドに`Europe/Bratislava`を入力する。このフィールドはタイムゾーン識別子ではなくUTC時刻を受け入れます。

## バージョンの違い

- バージョン6.4：JSONエクスポートは安定したフィールドキーを使用します；表示される列ラベルがキーになることはなくなりました。
- バージョン6.1〜6.3：JSONキーは表示される列ラベルに従います。アップグレード前に既存の統合を確認してください。
- 6.1以前：スケジュールされたJSONエクスポートは利用できません。CSVを使用するか、サポートされているバージョンにアップグレードしてください。

## エクスポートが届かない場合

ここに推測的な修正を追加しないでください。「スケジュールされたエクスポートが届かない」トラブルシューティングガイドを開いてください。そこでは、診断順にスケジュール状態、宛先認証、ファイル制限、およびサービスインシデントを確認します。

## 関連タスク

- 最初のスケジュールされたエクスポートを作成する — 順序立てられたセットアップと成功確認
- スケジュールされたエクスポートが届かない場合のトラブルシューティング — 症状主導の診断
- Northstar Analytics 6.4 リリースノート — 動作変更と移行に関する注記

## 検証記録

2026年8月27日、ReportingプロダクトオーナーによってWebアプリ6.4に対して検証済み。権限、フォーマット、保持期間、スケジューリング、または宛先の動作が変更されたときに見直してください。

デザインギャラリー

バリアント間で同一の設定、制限、ロール、バージョン情報を使用して、デザインレビューがコピーの違いではなく取得速度を測定できるようにします。

品質チェックリスト

ドキュメント記事は、該当するすべてのステートメントが真である場合にのみ準備完了です：

• 冒頭で正確なオブジェクトを指定し、背景や利点の前に現在の動作を示します。
• 製品、プラン、ロール、地域、プラットフォーム、バージョンの適用範囲が、回答を変える場合に明示されています。
• 前提条件が、それらに依存する設定や例の前に表示されます。
• すべての技術用語が最初の使用時に定義されるか、馴染みのあるインターフェースラベルで表現されるか、その正規の定義にリンクされています。
• フィールド、値、デフォルト、単位、フォーマット、制限、副作用は、権威あるソースまたは検証済みの製品テストから得られています。
• リファレンス表は一貫した次元を使用しています；空白のセルは不明なデフォルトや例外を隠していません。
• 例はそれらを有効にする条件を明記し、混乱が生じそうな場合には無効または境界の例を含めています。
• 警告は、破壊的で、元に戻せず、セキュリティに関わり、コストがかかる、または権限を変更する動作の前に表示されます。
• スクリーンショットにはキャプチャバージョンとテキスト相当物が含まれています；画像が値や指示の唯一の情報源ではありません。
• 見出しとアンカーはユーザーが検索する名詞に一致し、ディープリンクのために安定しています。
• 重要なバージョンの差異は、影響を受ける範囲、現在の置き換え先、移行の影響を明記しています。
• 検証日は動作のレビューを反映しており、指名されたチームまたはロールが次のレビューを担当します。
• 手順、診断、リリース履歴は、不完全に複製される代わりに、正規の兄弟ページにリンクされています。
• 公開インデックス作成は意図的です；古くなった、重複した、プライベートな、およびセキュリティに関わる資料には適切な検索処理が施されています。
• FAQレコードは表示される回答と一致し、CTAはサポート段階の読者の次のタスクを尊重しています。

よくある間違い

既存ユーザー向けの機能ランディングページを作成する。 「強力なエクスポートを解放」は読者が求める事実を遅らせます。動作、適用範囲、制約から始めます；ベネフィットコピーは目的を明確にする場合にのみ属します。

すべてのタスクをドキュメントに変える。 フィールドリストの下に埋もれた20ステップのセットアップは、ルックアップも完了も提供しません。順序付けられた手順をハウツーに分割し、該当する前提条件または関連タスクセクションからリンクします。

インターフェースラベルごとに1ページ公開する。 薄いページは重複し、メンテナンスが増大します。1つの設定が明確に異なる動作を持たない限り、フィールドを安定した製品オブジェクトの周りにグループ化します。

「最新」をバージョンとして使用する。 最新は変更されます。テスト済みリリース、サポート範囲、プラットフォーム、検証日を明記し、リリースプロセスを通じて更新します。

境界なく古いページと新しいページをインデックス可能に保つ。 互換性のある動作を統合します；そうでなければ古いバージョンをラベル付けし、現在のページにリンクし、インデックス作成を意図的に制御します。

前提条件をエラーの中に隠す。 Administratorのみがフィールドを変更できる場合は、リファレンスの前にそう明記します。Viewerが例に従った後にロールの境界を発見させるようなことをしないでください。

動作ではなくスクリーンショットをコピーする。 キャプチャは1つのインターフェース状態の証拠であり、仕様ではありません。ラベル、パス、値、条件をアクセシブルなテキストで記述し、キャプチャされたバージョンを記録します。

鮮度を偽装する。 動作を再テストせずに日付を変更すると、リスクを増大させながらページをより安全に見せかけます。該当するクレームを所有者が確認した後にのみ、検証記録を更新します。

公開検索で内部詳細を露出させる。 内部エスカレーション経路、秘密、顧客識別子、エクスプロイト手順、未発表の動作は、サポート負担を軽減するからといって安全になりません。公開ヘルプと認証済み・内部ナレッジを分離します。

内部リンク

著者が異なる回答の形を必要とする可能性がある場合は、 SEO投稿タイプへ上位リンクします。読者がそのタスクを最初に完了する必要がある場合にのみ、ドキュメントの前提条件から正規のハウツーへリンクします。汎用的な修正リストを挿入するのではなく、エラー状態からトラブルシューティングへリンクします。変更履歴がコンテキストを追加する場合は、バージョンの差異からリリースイベントへリンクします；リリースノートは、持続的な信頼できる情報源として現在のドキュメントにリンクバックする必要があります。

製品オブジェクトと読者の状態に基づいてリンクを整理します。長い関連記事リストに依存するのではなく、次の質問を生み出すステートメントの横に特定のリンクを配置します。

1つの正規の現在のページが安定した動作を所有する必要があります。ユーザーが依然として必要とする実質的に異なる動作がある場合にのみバージョンページを保持し、その区別を明示します。#table-2ではなく#retentionのような安定したアンカーを使用します。

結果の測定方法

ユーザーが自分のバージョンに対して正しい回答を取得するかどうかを測定します。トラフィックだけでは弱いエビデンスです：急増は製品の破損や古い回答を反映する可能性があります。

ターゲットクエリ、ランキングURL、インデックス可能性、サポートされているバージョン、サポート検索、関連タスクの離脱、適切な製品イベントを記録します。その後、以下をレビューします：

• 製品オブジェクト、フィールド、制限、構文、ロール、バージョンクエリの検索インプレッションと適格訪問
• 内部検索の絞り込み、結果ゼロの検索、および不足している用語を明らかにする繰り返し検索
• 未分化なページ滞在時間ではなく、アンカー付きセクションとのエンゲージメント
• 正しいセットアップ、トラブルシューティング、リリース、またはサポート先へのクリック
• プライバシーが許す範囲でバージョンとロールでセグメント化された、ページが回答すべき質問に関するサポート問い合わせ
• 値とそのプラン、バージョン、単位、または前提条件を保持した引用
• 統合または廃止後もランキングまたは引用されている古いURL
• リリース、インターフェース変更、ポリシー変更、および繰り返しのサポートケースによって引き起こされたドキュメント変更

ブランド化されたルックアップ質問とバージョンバリアントには プロンプトトラッキングを使用します。 ソースおよび引用インテリジェンスを使用して、回答エンジンがどのURLを引用し、そのサマリーが条件を保持しているかを確認します。 AmICited Cockpitを開いて、同じ観測期間における引用URL、可視性、オーガニックランディングアクティビティ、選択された製品またはサポートイベントを比較します。

結果の測定方法に従って、発見、表現、エンゲージメント、タスク進行、保持を分離します。動きを解釈する前にリリースとインシデントに注釈を付けます。ゼロクリック回答は、現在の値とその条件を保持する場合にのみ機能します。

FAQ

よくある質問