ユーザ用ツール

サイト用ツール


wiki:rule

Wikiの編集ルール

Wikiを編集する人は一読お願いします。


基本方針

ページ分類

ページ分類 意味
単一項目ページ 1つの事・1つの作業について説明したページ
項目一覧ページ 単一項目ページの全一覧
(全体の)作業手順ページ 一連の作業手順に沿って、単一項目ページのリンクを張るページ
wikiページ wikiの事について書かれたページ

編集ルール

  • 新規に作成するページはページ分類のいずれか1つに分類できるようにする
  • 1つのページに1つ以上の役割を持たせない
  • 名前空間を区切る時は半角英数字を使用する
  • wiki内のリンクは分かりやすいように別途、日本語表記にする
  • ページの1行目は大見出しにする
  • (wiki内のリンクを作成する時に見出しの内容が表示内容として使われるので)

編集ルールの目的

1つのページには1つの役割しか持たせません

例えば、バーチャルキャストで配信をするといったページを作成すると 全体の作業手順各工程の説明 という具合にページの役割が混ざってしまい、ネームスペースが区切りづらかったり、内容が若干重複しているページができる事があります。
こういった場合は SteamVRのセットアップ・バーチャルキャストの設定・OBSの設定・ニコニコの配信設定 とそれぞれのページに区切り、その後、それらのページをまとめて全体の作業手順のみを書いたページを別途作成してください。
そうする事で名前空間を明確にし、内容が重複する可能性を下げて、どこに何が書いてあるのかを分かりやすくします。

ユーザーレベルに合わせたページ設計

既存ユーザーや上級者は一覧から自分のやりたい事を素早く調べたいですが、初心者のユーザーは一覧を見てもどうすればよいか分かりづらいです。
なので、上級者向けとして単一項目ページの一覧のページ 初心者向けとして全体の作業手順が追えるページという風に分ける事で、ユーザーのニーズに合わせます。

また、バーチャルキャストの初心者であっても、Unity側の作業が分かっていたり、ニコ生の配信自体は分かってる事があります。
そういうケースを考えても、全体の手順と1つの事に対する作業手順を混ぜてしまうのは好ましくありません。

名前空間は半角英数字

全角文字(2byte)を使用してしまうとリンクが長くなり、改行の際に変な切れ方をする事があります。
サービスによってはリンクが文字数制限にもひっかかる可能性が高くなります。
wikiのリンクを外部に貼りやすくするためにも、名前空間は半角英数字で区切るようにしましょう。

[[namespace | 名前空間]]

ただし、そのままの表記では分かりづらいのでwiki内でリンクする時にはリンク先のページを日本語表記するようにしましょう。
上記のように | で区切って右側にリンクの表示を書く事ができます。


ページテンプレート

ページ分類 テンプレート
単一項目ページ 単一項目ページ(テンプレート)
項目一覧ページ -
(全体の)作業手順ページ 作業手順ページ(テンプレート)
名前空間の一覧 名前空間一覧ページ(テンプレート)

名前空間の区切り方について

  • 1番上の名前空間は サービスの種類・ツール・扱うデータの種類 で分けます
  • その下のカテゴリーは比較的柔軟に決めてOKです(既存ページの命名など参考にしながら)
  • 既存の名前空間に分類できそうなものは既存の名前空間に分類してください

名前空間の方針の基準として 何がどこにあるのか分かりやすくする・分類しやすくする を第一とします。
上記で触れてる 編集ルールの目的 がそのまま名前空間を決める基準になります。

画像ファイルの名前空間

  • 画像を掲載するページと同じ名前空間にする
  • カテゴリー名事に大文字やアンダーバーで区切る(item_make , ItemPointer 等)
  • 複数枚にまたがる場合は末尾に数字を付ければOK

大まかな方針としましては、他の人が見て分かりやすければOKです。
既に掲載されているメディアの中には上記のルールにあてはまらないものもありますが、それらは、古くなって差し替えになったタイミングや、ページを再編集した際に改めて差し替えればよいかと思います。

wiki/rule.txt · 最終更新: 2019/06/11 17:06 by navana

ページ用ツール