Skip to content

Latest commit

 

History

History
92 lines (52 loc) · 7.44 KB

File metadata and controls

92 lines (52 loc) · 7.44 KB
source-git-commit workflow-type source-wordcount ht-degree
15070ea99308741242b43206ed69cf1dbddca890
ht
719
100%

[!DNL Adobe Experience Manager] ドキュメントへの投稿に関するガイドライン

ドキュメントの理念

[!DNL Adobe Experience Manager] ユーザーは、競争の厳しい環境でビジネスを展開しており、競合他社より優位に立つためのデジタルエクスペリエンスを構築しようと懸命に努力しています。したがって、アドビが [!DNL Experience Manager] で高度な新しいツールを提供する際には、お客様が [!DNL Experience Manager] への投資をすぐに活かし ROI を最大化できるように、正確かつ明快なドキュメントでこれらのツールを補うことが不可欠です。

[!DNL Experience Manager] ドキュメントの目標は、ドキュメントをできるだけ早く [!DNL Experience Manager] ユーザーに届けることです。そのため、正確で使いやすいドキュメントを最優先し、ドキュメントの継続的な更新と改善に努めます。

ドキュメントの投稿

[!DNL Experience Manager] ドキュメントを継続的に改善するため、[!DNL Experience Manager] ユーザーコミュニティ全体からドキュメントに投稿いただければ幸いです。変更修正依頼(プル要求)であるか問題報告(イシュー)であるかを問わず、修正、明確化、増補、例の追加などがドキュメントの改善になります。

ドキュメント標準

アドビのドキュメントへの投稿を歓迎しますが、[!DNL Experience Manager] ドキュメントへの投稿は、プル要求またはイシューの形式で行い、投稿とドキュメントに関するアドビの標準に準拠する必要があります。

標準に合致しない投稿は拒否される可能性があります。

標準的な使用例を記載する

[!DNL Experience Manager] ドキュメントでは標準的な使用例を扱っています。製品の標準的なインストールや使用の範囲を超える使用例は、[!DNL Experience Manager] ドキュメントに含まれていません。

バグやそれらの回避策については一般に記載しない

[!DNL Experience Manager] ドキュメントでは標準的な使用例を扱っています。この理由から、バグ、バグによる影響、バグの回避策は、一般にドキュメントには記載されません。

ただし、既知の問題と [!DNL Experience Manager] 製品管理部門で承認された実行可能な解決策を記載できるリリースノートは、このルールの例外です。

ドキュメントへの投稿は技術的な質問に回答するためのものではない

[!DNL Experience Manager] ドキュメントの改善に役立つアイデアの投稿を歓迎します。ただし、コメント、問題報告(イシュー)および変更修正依頼(プル要求)は、投稿​専用です。これらを、[!DNL Experience Manager] の使用方法、[!DNL Experience Manager] プロジェクトの実装方法、技術的な問題の解決方法についての質問に回答するために使用することはできません。

[!DNL Experience Manager] の使用方法や技術的な問題に関して質問がある場合は、[!DNL Experience Manager] サポートポータルの通常のサポートプロセスを通じて報告したり、Adobe Experience Manager コミュニティでディスカッションしたりする必要があります。

[!DNL Experience Manager] ドキュメントの投稿は、アドビのカスタマーサポートに代わるものではありません。​サポート関連の質問に対する回答を求めるような投稿は拒否されます。

投稿は、影響を受けるドキュメントページを明確に参照する必要があります。

ドキュメントの改善を提案するイシューを作成する場合は、影響を受けるページへのリンクを含める必要があります。ドキュメントページで「このページを編集」リンクを使用してイシューを作成すると、そのイシューは自動的に該当ページへのリンク付きで作成されます。

プル要求は影響を受けるページを参照するので、プル要求には適用されません。

ドキュメントガイドライン

アドビのドキュメントに投稿していただく場合は、特定のスタイルガイドラインに従ってください。

これらのガイドラインに従っていただくと、投稿のレビューが容易になり、投稿がアドビのドキュメントにすばやく統合されるようになります。

言葉遣いとスタイル

言葉遣い

  • [!DNL Experience Manager] ドキュメントは米国英語で作成および維持管理されています。
  • 文章をできるだけ簡単にしてください。
  • 言葉遣いを明快かつ簡潔にしてください。

[!DNL Experience Manager] ドキュメントの読者は世界中に存在し、英語が母国語である、または英語を流暢に使えるとは限りません。口語的な表現を避け、言葉遣いをできるだけ明快で簡潔なものにしてください。

マイクロソフトのスタイルガイドへの準拠

マイクロソフトのスタイルガイド『The Microsoft Manual of Style』(英語版)は、ソフトウェアドキュメントに重点を置いたドキュメントスタイルガイドで、無料で入手できます。[!DNL Experience Manager] ドキュメントは、可能な限り、このガイドに従っています。

書式設定

項目 スタイル
UI 要素またはオプション 太字
ファイル名、パス、ユーザー入力、パラメーター値 monospaced
コード、コマンドライン Code Block

スクリーンショット

スクリーンショットは慎重に、かつ、テキストによる説明が不十分な場合にのみ使用します。

マーカーやその他の注釈(赤枠、矢印、テキストなど)はスクリーンショットに対して使用しないでください。こうすれば、スクリーンショットをドキュメントのローカライズ版で再利用またはレプリケーションしやすくなります。

バージョン固有の参照

ドキュメントコンテンツ全体で特定バージョンへの直接参照をできるだけ避けてください。これにより、今後のバージョンについて、ドキュメントの柔軟性と拡張性が高まります。

呼称としての Day、[!DNL Experience Manager]、CQ、CRX の使用

記事の最初に使用する際は、製品を Adobe Experience Manager という完全な名前で参照し、その後は Experience Manager として参照します。

Day、Day Software、CQ、CRX の用語は使用しないでください。ただし、クラス名や [!DNL Experience Manager] の履歴を参照する場合など、避けられない場合を除きます。