Project:PD help/ja
From MediaWiki.org
|
Project:PD help, はMediaWikiユーザー、すなわち、MediaWikiによって運営されているウェブサイトへの訪問者のための簡潔なユーザーヘルプページを作成するプロジェクトです。プロジェクトはHelp名前空間にあるすべての内容をカバーします。このためのメインのエントリーポイントはHelp:Contents/jaです。 このヘルプドキュメンテーションはProject:Manual (GFDLライセンスのMediaWiki管理者のマニュアル) から分離しています。投稿者の方はそれらの違いについてしっかりと理解しているようお願いします!PDヘルプページはサーバー管理者のための、MediaWikiをインストール、設定もしくは維持することに関する情報を含みません。私達が達成しようとしている詳細な内容に関しては下記のゴールのセクションをご覧下さい。
|
Contents |
[edit] ゴール
アイディアは新しいwikiインストレーションにコピーできる、もしくはmediawikiディストリビューションに含めることができるページのセットを提供しようとすることです。これは、もっとも簡潔な形式で、基本的なユーザー情報と他のmeta情報を含みます。基本的なコンセプトは参考資料ではなく、圧縮したユーザーガイドを作成することです。これは他の機能を説明することではなくユーザーがしたいことに焦点を当てることです。
[edit] ライセンス
PDヘルプへの投稿は(通常のGNU Free Documentation Licenseではなく)パブリックドメインとして公開されます。これは利用者がテキストをそれぞれのwikiインストレーションに簡単にコピーできるようんするために必要です。投稿する間に次の内容を理解しているか確認して下さるようお願いします:
- PDヘルプのすべてのページはライセンスを示すために
{{PD Help Page}}の行を含まなければなりません。 - 自分が著者であるもしくは著者から許可されている以外他の場所からこれらのページに内容をコピーしないで下さい。既にパブリックドメインである内容はここにコピーできますが、これはほとんどのウェブページに含まれません!
- ここに投稿した情報に関するすべての権限を放棄しています。投稿はこのサイトに一覧表示されこのサイトに帰属を続けますが、他の人はクレジット無しでテキストをコピーし、適当に修正できます。
[edit] ターゲットの読者 - 普通のユーザー
ヘルプページはwikiのウェブサイトに訪問する普通のユーザーにとりわけターゲットを絞っています。
[edit] サーバー管理者ではない
別の重複したMediaWikiドキュメンテーションを作ろうとしているわけではありません。サーバー管理者をターゲットとした情報、MediaWikiの詳細なインストレーション、設定もしくはメンテナンスはManualに属します。
この唯一の小さな例外は'Admin tips'のボックスです (下記で説明)。
[edit] sysop / bureaucratユーザーのための情報は控えめに
ヘルプページは完璧なものではなく、ターゲットの聴衆(wikiユーザーの多数派)が利用できない高度な機能が存在しますが、'sysop'ユーザーができることについての説明は無しです。そういうものとして、通常のユーザーが彼らに関係のない情報に遭遇しないようにこの情報を少し分け隔てたものとして保持します。ヘルプページのbulkの範囲でsysopの権限が要求されることについて手短な言及を行いますが、sysopsの手続きの詳細な説明はリンクされたページに任せるべきか、すべて省略すべきです。
このセクションは議論の最中です
[edit] 編集ガイドライン
- ページ間のリンクを作成しますが、MediaWiki.orgの他の名前空間へのリンクは避けます。内部リンクはパブリックドメインのヘルプページに保つか、meta.mediawiki.org上の関連したリソースへの外部リンク(フルURL)を作成して下さい。これはテキストを新しいwikiインストレーションにコピーする作業を円滑にするためです。ターゲットのwikiに存在しないかもしれないインターウィキリンクは使わないで下さい。
- Category:Helpページの外部のMediaWikiのサイトのページにリンクする場合、[http://www.mediawiki.org/wiki/Project:Support_desk Project:Support desk]のような外部リンク(フルURL)を使用して下さい --Grymwulf 18:33, 24 December 2006 (UTC)
- もはや{{SITENAME}}構文について説明しようとは思いません。 MediaWikiは我々が説明しているソフトウェアの名前です。これは目的のwikiを供給するソフトウェアなので、テキストがソフトウェアを言及しているところ(ヘルプ全体のすべての場所
)はどこでも"MediaWiki"リテラル文字として残すべきです。何らかの理由でヘルプテキストがサイトの名前を言及している場合、これは適切な例外になるべきですが( {{SITENAME}}を使って下さい)、MediaWikiという単語を言及する場所でこれについて言及しません。
- 翻訳は英語バージョンのページが安定状態に達した後に行うべきです。命名規約は
Pagetitle/language-codeです。
- このマニュアルでナビゲーションに対して完璧な解決方法が内限り、ナビゲーションテンプレートを作ることは控えまずは内容を作成して下さい。
[edit] 形式
- 形式は一貫性があるべきです。作成したどのテーブルもしくは
{{Hl1}}などを持った列に対して{{Prettytable}}を使って下さい。(Template talk:Prettytableを参照)
- すべてのwikiマークアップコードは
<code>もしくは<pre>タグ内に設置しなければなりません。挿入に関するヘルプ:{{subst:nw|text}}
- メニューのテキストと説明へのすべてのリファレンスはイタリックで説明されるべきです。
[edit] スクリーンショットの画像
ヘルプページ上にスクリーンショットの画像が必要であるか議論があります。talk page here、とProject:Current issues#MW Screenshots - Image licenseもご覧下さい
これが決定されるまでスクリーンショットは非推奨です。すなわち、それ以上追加しませんが、既存のものは削除しません。
スクリーンショットの画像の利点
- 画像は言葉よりも多くの情報を伝えます。よりフレンドリーなユーザーヘルプのために、説明図を提供することは大事です。
スクリーンショットの不利な点
- MediaWikiは組み込みのインポート/エクスポート機能を持ちますが、画像では動作しません。
- ライセンスの問題。MediaWikiのスクリーンショットはPDライセンスにできるか?
- それ無しでできる。ヘルプページで説明するために説明用の画像は必要ではない。
[edit] 管理者のティップス
ヘルプページの中でサーバー管理者によって設定できるものがある場合、{{Admin tip|tip=text}}でアドミンティップを挿入できます。
[edit] カテゴリ
"Help:"名前空間のすべてのページはこのパブリックドメインのHelpドキュメンテーションによる定義でMediaWiki.orgのデフォルト言語である英語の場合、Category:Helpに分類すべきです。英語ではない場合、Category:Help/fr (フランス語)、Category:Help/de (ドイツ語)などに分類します。
"Help:"名前空間のページの前者のカテゴリー、このパブリックドメインのHelpドキュメンテーションプロジェクトは、Category:PD Helpでした。簡潔性を保つためにカテゴリーは現在シンプルなCategory:Helpですべてのページが更新されました。
[edit] 関連項目
- Project:Language policy/ja ヘルプページの非英語バージョンに取り組むことに興味がある場合。
- Project:PD help/export Help: 名前空間の利用できるダンプを作成する方法の提案について議論しています。これはまだ議論の段階でまだ機能になっていません。
- Project:PD help/mirroring interimで使われているMediaWiki.orgから内容を取得する別の方法について議論しています。