Liferayスタイルガイド

これは、Liferayが公開するコンテンツ（製品ドキュメントとコースの両方）のスタイルガイドです。 それは巨人の肩の上に成り立っています。 『シカゴ・マニュアル・オブ・スタイル』 と、ストラングとホワイトの 『スタイルの要素』です。 このガイドに明記されていない箇所については、そこに書かれている内容を前提としてください。

このガイドには、以下の4つの包括的な価値観があります。

1. 内容は網羅的であり、読者が知っておくべきことをすべて網羅しています。

2. 内容は簡潔で、要点を的確に伝え、無駄な表現を避けています。

3. コンテンツは 一貫性があり：個々の記事は全体的なメッセージに関連しています。

4. コンテンツの明瞭度は です。メッセージが可能な限り多くの視聴者に可能な限り明確に伝わります。

ガイドの構成

記事	内容
コアスタイル	声のトーン、口調、言い回し、普遍的な構成原則、専門用語、ルールの優先順位、および同点の場合の決定方法。 すべての Liferay コンテンツに適用されます。
書式設定	テキストの強調表示、コード、リスト、表、見出し、画像、注意書き、およびファイル名。 すべての Liferay コンテンツに適用されます。
文書スタイル	製品ドキュメントに特有のルール：6種類のドキュメントタイプ、それぞれのテンプレート、複数バージョンの取り扱い、およびドキュメントバッジ。
コーススタイル	コース固有のルール：コースとモジュールの構成、Clarity Vision Solutionsのケーススタディ、命名規則、レッスンと演習のパターン、学習目標、評価、コースのビジュアル。

執筆またはレビューを行う際は、まず コアスタイル と フォーマット を読んでください。これらは、あらゆる記事の大部分を規定するルールを定義しています。 次に、作成しているコンテンツに合致する記事を参照してください。

あなた

このガイドに記載されている基準は、長年にわたるコンテンツの定義、テスト、改良の成果です。 彼らは完璧ではない。 不明な点や納得できない点がある場合は、 Liferay Discuss を通じてフィードバックを送信してください。