テンプレートは、MediaWikiによる非常に有益なツールですが、Wiki構文に慣れていないもしくはわからないユーザにとっては非常に難解なものです。また、経験のあるユーザにとっても理解するのは難しい場合もあります。そのため、一般のユーザにも使いやすいようにドキュメントを付けることによって利便性を向上させる必要があります。
ドキュメントに必ず含むべきもの[]
テンプレート・ドキュメントには以下の項目を必ず含むべきです。
- そのテンプレートの基本的な使用目的：何のために、どういうときに使うテンプレートなのかの明記がないと誤った利用方法がなされる場合があります。
- そのテンプレートのパラメータ：テンプレートで定義しているパラメータの意味や、ユーザが書き換えるべき箇所や書き換えてはならない箇所などを明記すべきです。
- 使用例：百聞は一見にしかずといわれるように、実際にそのテンプレートを使った見本を置くべきです。
- 関連テンプレートのリンク：複数のテンプレートとの関連などがある場合、それらのテンプレートとのリンクをおくべきです。
- 適切なカテゴライズ：そのテンプレートに含むべきカテゴリや、テンプレート自身のカテゴリを定義しておくべきです。
テンプレート・ドキュメントは基本的にはそのテンプレート記事の中に直接書き込まずに、ドキュメントのサブページに外出しで書くべきです。テンプレートファイル自体の容量を少しでも小さくすれば、そのテンプレートを使用している記事のレスポンスも改善されます。
また、ドキュメントを外出しにする場合には必ず<noinclude>{{/doc}}</noinclude>で囲むべきです。不要なカテゴリがテンプレートに反映されることを防ぐために必ず行ってください。
ドキュメントはどうやって作成するのか[]
|
この記事は書きかけだ。是非とも、この記事に加筆してみて欲しい。記事を書く際は、画面上部の「編集」をクリックするように。 |