編集ガイドライン

気楽なwikiなので特にないのですが、今後こうするとよいかなというものをメモ。

• 基本的には、ですます調の読みやすい文章を心がける（むやみに難しい表現を用いない）。
• ブロック要素は外側の要素ほど多くの { } を持つ形で記述する。
  • multilangは中にブロック要素を持つ可能性が高いので、少なくとも3重 {{{ }}} 以上で記述する。
• ページ最初の文章はページの要旨を簡単にまとめる。
• 文末では改行する。これはより差分区間をわかりやすくするための措置であり、長い文章なら読点でも改行してよい。
  • 箇条書きではこの規則で改行をすることがやや難しいが、逆に言えば長く文章を連ねるような箇条書きなど書くべきではない。
• 必要ならば、多言語で情報を掲載するためにmultilangプラグインが利用可能である。しかし、利用にあたっていくつか注意がある。
  • 見出しにはmultilangを用いない。#contentsx等のプラグインがうまく動作しなくなるため。
  • multilangの区間はそれぞれの言語で対応がおこなわれていること。日本語「文A 文B」「文C」に対して、英語「文A」「文B 文C」のように、ブロックの区切りを変えないでということ。
  • 言語によって情報量が変化することは望ましくない。
    • 日本語で見ると3つの技について書かれているのに、英語で見ると1つしか書かれていない、というような事態はよくありませんということ。
    • 翻訳できない場合は無理に翻訳する必要はない。その場合、情報量を減らさないという観点から、英語閲覧時でも不足分の日本語の文章が見えるようにしておく。
• タグ・見出し更新時は必ずタイムスタンプを更新する
• 見出しにつくアンカーはデフォルトのランダム文字列ではない、意味のある文字列が望ましい。

あくまで指針なので厳密に守らなければいけないということはないです。
既存のページもこういった形で書き直したいところ（このページも）。

コメント (Comments / Discussions)

Tag: スタブ