openSUSE 記事スタイルガイド

OpenSUSE Style Guideから転送)
移動先: 案内, 検索

あなたがWikiに記事を作ったり編集したりする場合は、下記のガイドラインに沿うようにしてください。

記事のタイトル


記事に付けるタイトル(ページ名)は、そのままページの見出しになります。記事のタイトルは明解なものになるよう心がけ、暗号のような略語やCamelCase(訳注:複数の英単語の各1文字目を大文字にしてつなげ、1語として書くこと)は使わないでください。本文の文頭に再度タイトルを書く必要はありません。自分だけが理解できる 名前空間 を勝手に作らないでください。タイトル・スタイルの記述(訳注:単語の1文字目を大文字にすること。日本語では関係なし)をしてください。

見出し


  • 見出しを書く場合は太字を示す記号である ''' ではなく、= 記号(見出し記号)を使います。そうすれば自動的にページの内容一覧(目次)が作成されます。
  • 見出しの階層は、2つの == からではなく、1つの = から始めます。例えば以下のように:
=大見出し 1=
==中見出し 1.1==
==中見出し 1.2==
=大見出し 2=
==中見出し 2.2==
===小見出し 2.2.1===
====孫見出し 2.2.1.1===
  • 見出しを作る際は、ページを読む人が興味のない個所を飛ばして読みたい部分を容易に発見できるようにしてください。
  • もしあなたの書いた文章が長くなりすぎたようだったら、それを小見出しや孫見出しに分割できないかどうか、検討してみましょう。
  • 見出しもタイトル・スタイルの記述をしてください。

文章へ記号付け(マークアップ)する


あなたが書いた文章をより読みやすくするために、MediaWiki の書式および記号(マークアップ)を使いましょう。ファイル名やシェルのコマンドは、下記のように fixed font (等幅フォント)を指定します。

<tt>fixed font</tt>

MediaWiki で用意されている書式を使う


どうしても必要な場合を除いて、HTMLの書式(タグ)は使うべきではありません。MediaWiki の書式を使えば、記事の見た目や印象が統一されるうえ、ソースコード(記事の元のコード)を書いたり読んだり編集したりする作業が容易になります。 どんな書式や記号が使えるのかは、MediaWiki editing help日本語版)を参照してください。 また、 Wikipedia日本語版)に掲載されている記事のソースコードを参考にするのもよいでしょう。

コメントの記入


読者は、discussionページ(ページ最下段の「discussion」あるいは「ノート」のリンク)にコメントを書きます。記事の本文中にコメントを書いて、記事を読みづらくしないでください。

執筆者は、{{Expand}} テンプレートを使う場合を除き、未完成の記事や追加の必要がある記事を掲載すべきではありません。

同様に、本文のない見出しや目次を作ることで、読者にとって読みやすくなることもあります。

もし執筆者が他の編集者とコミュニケートを図りたい場合は、一般の読者には見えないかたちでコメントを書くことができます。他の編集者にだけ見せたいテキストを <!----> のタグで括って入力してください。

以下に例を示します:

hello <!--ここにコメントを入力。--> world

上記のようにコメントを入力すると、下記のように見えます:

hello world

コメントは、HTML や Wiki のソースコードを参照したときにだけ読むことができます。

不自然に Wiki を膨張させないこと


記事は、少なくとも関連する最小限の情報を含む(まとめる)ように作成してください。1つの記事は、誰かが書いた他の記事からそこへリンクできるように作成するのが Wiki 流のやり方です。もし、存在しない記事に対して2つ以上のリンクがはられている場合、その記事は 投稿が望まれるページ のリストに表示されます。