ユーザ用ツール

サイト用ツール


wiki:rule

Wikiの編集ルール


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


wikiの方針


ページ分類 意味
単項目ページ 1つの内容ついて説明したページ
ネームスペースはツール・サービス・データ形式 等の単位で区切る
ガイドページ 単項目ページへのリンクだけを行うページ

wikiでは基本的に単項目ページガイドページの2種類のページしか作成しません。
例えば「VRMの作り方」を説明しようとした場合…
Unityの準備、VRMの仕様や設定方法、MToonの設定、SEEDへのアップロード、VirtualCastの作業…
といった感じで、多くのツールや物事について横断的に説明する必要があります。

この時に作業手順ベースでページを作成してしまうと、
VRMの作り方以下のネームスペースに様々なジャンルの情報が掲載され検索性が落ちます、また、別の作業手順の説明をした際に似たような内容を再掲載してしまったり、作業全体ではなく特定の事だけ知りたいのに、作業全体を順番になぞって探す必要がある等の問題が発生します。


なので、具体的な内容は単項目ページに持たせ、
作業手順や全体を俯瞰したページを書きたい場合ガイドページとして作成して、単項目ページへのリンクだけ持ちます。
そうする事で、重複した作業内容を繰り返し書く必要がなくなり、保守するページも最小限になります。
ページを作りすぎてもwikiの構造が複雑になり保守コストが上がり検索性が落ちるので、不足なく必要なページのみを作成するように心がけます。



ページ分類

ページ分類 意味
単項目ページ 1つの内容ついて説明したページ
ネームスペースはツール・サービス・データ形式 等の単位で区切る
ガイドページ 単項目ページへのリンクだけを行うページ
wikiページ wikiの事について書かれたページ
ネームスペース 各カテゴリーのネームスペース一覧が書かれたページ

ページテンプレート

ページ分類 テンプレート
単項目ページ 単項目ページ(テンプレート)
ガイドページ ガイドページ(テンプレート)
ネームスペース一覧 ネームスペース一覧 (テンプレート)

編集ルール

  1. 新規に作成するページは ガイドページ か 単項目ページ のどちらかを作成する
  2. 単項目ページのネームスペースは ツール、サービス、データ形式 等で分類する
  3. 単項目ページは1つの内容について書く
  4. ガイドページには詳細な内容は書かず、単項目ページへのリンクを掲載する形で説明を行う
    (俯瞰的な概要については適宜記述)
  5. ネームスペースは半角英数字を使用する

ネームスペースは半角英数字について

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

[[namespace | ネームスペース(リンク名として表示される)]]

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


ネームスペースの区切り方についての詳細

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

ネームスペースの方針の基準として 何がどこにあるのか分かりやすくする・分類しやすくする を第一とします。ネームスペース通りに単項目ページを並べると目次になるような状態が理想です。

画像ファイルのネームスペース

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

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


:top ページの作成ルール

TOPのページにはそれより下のネームスペースを羅列します。目次のような役割を果たすと理想です。
ページ数が増えてTOPページが長くなる場合、ネームスペースが細分化されてるページは折り畳み機能を使用して見やすくします。
折り畳みのタイトルには (クリックで展開) を含めてください。(展開できると思われない場合があります)

--> 〇〇一覧 (クリックで展開) #

  * 1
  * 2
  * 3

<--
wiki/rule.txt · 最終更新: 2019/09/09 13:10 by navana

ページ用ツール