ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。

Liferayドキュメントフォーマット

ドキュメントの形式、つまりドキュメントのスタイルの構成方法は、エクスペリエンスの一貫性を維持するために重要です。読者がドキュメントをより多く利用するようになると、機能がどのように提示され、説明されているかの構成がわかってくるはずです。これを可能にするには、作成者は形式の規則に従う必要があります。

紹介タイトルに「Introduction」という言葉を決して使用しないでください

言い換えれば、紹介の名前を「 …の紹介」にしないでください。

機能ドキュメントを可能な限り独立させる

各特集記事は可能な限り独立している必要があります。読者が同じトピックに関する別の記事を読んだことがある（または読んだ可能性がある）と決して想定しないでください。別の記事にリンクすることが役に立つ場合は、必ずリンクしてください。ただし、次のような表現は避けてください。

Foos の記事の画面下部にある大きな赤いボタンに気づいたかもしれません。これが何をするかです。

代わりに、次のようにします。

フォームの下部に、この別の関数があります。使い方は次のとおりです。

ステップの紹介

読者が実行すべき一連の手順がある場合、見出しのすぐ下にそれらの手順を導入しないでください。手順を直接リストします。

例 1 (これはしないでください):

## Editing Fields

To edit fields,

1. Step one

例 2 (これを行う):

## Editing Fields

1. Click the _Edit_ button.

1. Enter a name...

機能の比較

公開ページや非公開ページなどの項目間の機能を比較する場合は、チェック付きの表を使用します。

| Behavior | Public Pages | Private Pages |
| --- | --- |---|
| Visible to unauthenticated users | &#10004; |  |
| Viewing requires Login and Site Membership |  | &#10004; |
| Distinct URL pattern | &#10004; | &#10004; |

上の表は次のように表示されます。

動作	公開ページ	非公開ページ
認証されていないユーザーへの表示	✔
閲覧にはログインとサイトメンバーシップが必要		✔
独自のURLパターン	✔	✔

UI要素の強調表示

UI 要素を強調表示することは、ユーザーに機能の使用方法を示す優れた方法です。 UI 要素を強調表示するには、ボックスの強調表示と数値注釈の 2 つの方法があります。

ボックスのハイライトを使用した例:

UI 要素の周囲にボックスを描画して注釈を付けます。

数値注釈の使用例:

数値注釈は、以下のテキストでその注釈の定義とペアにする必要があります。

数値注釈を使用する場合は、画像の下のテキストに何が描かれているかを定義します。

図表/視覚補助

Liferay の機能が相互にどのように関連しているか、機能の目的や機能など、読者が概念を習得するのに役立つと思われるものなど、複雑な概念をユーザーが理解しやすくするために図を追加します。

ビデオ

動画を YouTube にアップロードし、YouTube トークンを使用して記事内で参照します。

<iframe allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen frameborder="0" height="315" src="https://www.youtube.com/embed/x7fm_nCZ0sY" title="YouTube video player" width="560"></iframe>

複数のLiferayバージョンのドキュメント化

Liferay のドキュメントはバージョンレスであり、常に最新バージョンをサポートします。場合によっては、古いバージョンのドキュメントが必要になることがあります。

Liferayが機能のユーザーインターフェースを変更する場合
Liferayが機能を廃止または削除したにもかかわらず、ユーザーが古いバージョンをまだ使用している場合
Liferayが既存の機能に新しい機能を追加する場合

このような場合、ドキュメントでソフトウェアの複数のバージョンをサポートする必要があります。そのための方法はいくつかあります:

新しいソフトウェアのマイナーバージョンの変更について説明するために新しい記事を作成しないでください。同じソフトウェアメジャーバージョンのコンテンツはすべて同じ記事に保持します。
最新の情報を記事の上部に、最も古い情報を下部に配置します。
既存のドキュメントの変更の影響を評価します。
- 軽微な変更の場合は、バッジ (上記参照) を使用して、コンテンツがどのバージョンに適用されるかを読者に知らせます。変更にヘッダーが必要な場合は、ヘッダーの直後にメモを配置します。
- 大きな変更については、専用の H2 セクションを使用して変更内容を説明し、トピックの先頭に H2 を相互リンクするメモ形式の警告を配置します。