Meta:JA/Guides/Style Guide

提供: wiki
移動先: 案内検索

テンプレート:Meta:JA/Guides/index

in progress Inprogress100.jpg 100%

 

すべてのBlenderドキュメントの一貫性を保つためにも、スタイルガイドに従いましょう。

大きく変更したい場合は、執筆者ガイドに従い、他の執筆者と話しあうようにしてください。

一般ガイドライン

コンテンツ

  • 明確で簡潔であれ
  • 正確な英語らしい英語であれ(アメリカ英語推奨)

ページ構成

  • 閲覧者を誘導しやすいように、ヘッダやフッタに マニュアル|チュートリアル|リファレンス というような案内を挿入しましょう。
  • ページを章や節、項に分けましょう。
  • ざっと見るために、タイトルの直後に、トピックについてまたは特に長い章であれば目的やコンテンツについての概略を挿入しましょう。
  • トピックをひとつのページにするには長すぎるのであれば、サブページに分けましょう。

参考資料

ユーザマニュアルとして参考資料を書く際には、Template:RefBoxテンプレートに関連するサブタイトルを入れて使ってください。これによって、分かりやすく判別しやすいところで、共通する情報とマニュアルを関連づけることができます。そうすれば、探しやすくなった情報をざっと読むことが出来ます。

編集ガイドライン

執筆

画像やメディアコンテンツなど、ファイルの挿入

相互参照

  • 相互参照はwikiらしさがあります。ページ(ファイルや画像)へのリンクには、ただ名前を角括弧で囲めばいいのです。例えば、[[Doc:Manual|Blender's user manual]]または[[Doc:Manual]]のように。
  • BlenderWikiにあるページリンクを、 (http://wiki.blender.org/index.php/....) のようにそのまま使わないこと。