「ヘルプ:記事命名ガイドライン」の版間の差分

提供: ArchWiki
ナビゲーションに移動 検索に移動
(言語間リンクの追加)
(→‎Multi-language articles: セクション見出しを →‎翻訳されたページ: に変更)
(同じ利用者による、間の5版が非表示)
30行目: 30行目:
 
=== サンプル ===
 
=== サンプル ===
   
"Boost pacman" (「pacman の高速化」) のようなタイトルは読者を勘違いさせてしまう可能性があります。ユーザーは pacman の「何か」を高速化させる記事だと考えるでしょうが、記事の内容が思っていたものと同じだとは必ずしも限りません。したがって、記事の名前はできるだけ分かりやすくそれでいて長くなりすぎないようにしてください。例として出した記事の名前は "How to improve pacman download speed using wget, snarf, and lftp" と具体的にすることができます。
+
「pacman の高速化」のようなタイトルは読者を勘違いさせてしまう可能性があります。ユーザーは pacman の「何か」を高速化させる記事だと考えるでしょうが、記事の内容が思っていたものと同じだとは必ずしも限りません。したがって、記事の名前はできるだけ分かりやすくそれでいて長くなりすぎないようにしてください。例として出した記事の名前はwget, snarf, lftp などを使って pacman のダウンロード速度を改善する方法」と具体的にすることができます。
   
 
== 記事の追記の余地を残す ==
 
== 記事の追記の余地を残す ==
40行目: 40行目:
 
=== サンプル ===
 
=== サンプル ===
   
前の例に戻ってみましょう。新しい記事のタイトルは "Improve pacman download speed using wget, snarf, and lftp" です。しかしながら、新しいダウンロードマネージャが登場して wget, snarf, lftp などを置き換える日がいつか来るかもしれません。したがって記事の名前をもう少し普遍的なものに変えます: "How to improve pacman download speed using alternative download managers"
+
前の例に戻ってみましょう。新しい記事のタイトルはwget, snarf, lftp などを使って pacman のダウンロード速度を改善する方法」です。しかしながら、新しいダウンロードマネージャが登場して wget, snarf, lftp などを置き換える日がいつか来るかもしれません。したがって記事の名前をもう少し普遍的なものに変えます:「代わりのダウンロードマネージャを使って pacman のダウンロード速度を改善する方法」
   
 
== 記事の名前は短くする ==
 
== 記事の名前は短くする ==
48行目: 48行目:
 
記事のリストをすばやく一瞥できるように記事の名前は短くしてください。ほとんどの人は wiki を読むときブラウズテクニックを使うので、長々とした名前を記事に付けると無駄に時間を浪費させることになります。また、短い名前はプロフェッショナルっぽく聞こえます。
 
記事のリストをすばやく一瞥できるように記事の名前は短くしてください。ほとんどの人は wiki を読むときブラウズテクニックを使うので、長々とした名前を記事に付けると無駄に時間を浪費させることになります。また、短い名前はプロフェッショナルっぽく聞こえます。
   
以下では "How to improve pacman download speed using alternative download managers" という名前を例として使っています。
+
以下では「代わりのダウンロードマネージャを使って pacman のダウンロード速度を改善する方法」という名前を例として使っています。
   
 
名前を短くするテクニックを全て挙げることはできません。使用できるテクニックは他にもたくさんありますが、とりあえずタイトル編集の「概念」を理解するには役立つでしょう。
 
名前を短くするテクニックを全て挙げることはできません。使用できるテクニックは他にもたくさんありますが、とりあえずタイトル編集の「概念」を理解するには役立つでしょう。
56行目: 56行目:
 
=== 質問形式の名前は使わない ===
 
=== 質問形式の名前は使わない ===
   
"How to improve" とするかわりに、シンプルに "Improve" としてください。
+
「改善する方法」とするかわりに、シンプルに「改善」としてください。
   
 
以下の二つを比べてみて下さい:
 
以下の二つを比べてみて下さい:
   
  +
* 代わりのダウンロードマネージャを使って pacman のダウンロード速度を''改善する方法''
* "''How to improve'' pacman download speed using alternative download managers"
 
  +
* 代わりのダウンロードマネージャを使って pacman のダウンロード速度を''改善''
* "''Improve'' pacman download speed using alternative download managers"
 
   
 
=== 長い語句は言い換える ===
 
=== 長い語句は言い換える ===
   
"Improve pacman download speed" という文章は冗長です。代わりに、"Speed up pacman download" とします。
+
「ダウンロード速度を改善」という文章は冗長です。代わりに、「ダウンロードを高速化」とします。
   
 
以下の二つを比べてみて下さい:
 
以下の二つを比べてみて下さい:
   
  +
* 代わりのダウンロードマネージャを使って pacman の''ダウンロード速度を改善''
* "''Improve pacman download speed'' using alternative download managers"
 
  +
* 代わりのダウンロードマネージャを使って pacman の''ダウンロードを高速化''
* "''Speed up pacman download'' using alternative download managers"
 
   
 
=== 装飾的な語句は避ける ===
 
=== 装飾的な語句は避ける ===
   
装飾的な語句(例えば前の例では "alternative")だけが装飾的ではありません。それらの語句は普通の語句に比べてあまり使われず、長い傾向にあります。日常的に使う語句はほとんどの場合短いことが知られています。一般的な代わりの語句を探してみてください。
+
装飾的な語句(例えば前の例では「代わり」)だけが装飾的ではありません。それらの語句は普通の語句に比べてあまり使われず、長い傾向にあります。日常的に使う語句はほとんどの場合短いことが知られています。一般的な代わりの語句を探してみてください。
   
"alternative" と言う代わりに、"other" と言うことができるかもしれません。
+
「代わり」と言う代わりに、「他」と言うことができるかもしれません。
   
 
以下の二つを比べてみて下さい:
 
以下の二つを比べてみて下さい:
   
  +
* ''代わりの''ダウンロードマネージャを使って pacman のダウンロードを高速化
* "Speed up pacman download using ''alternative'' download managers"
 
  +
* ''他の''ダウンロードマネージャを使って pacman のダウンロードを高速化
* "Speed up pacman download using ''other'' download managers"
 
   
 
=== 正式な技術的表現からの逸脱 ===
 
=== 正式な技術的表現からの逸脱 ===
87行目: 87行目:
 
技術に精通しているユーザーからは賛成されないかもしれませんが、大抵の人は全く気にしません。記事の名前が短くなるなら、技術用語を使わないようにしてください。
 
技術に精通しているユーザーからは賛成されないかもしれませんが、大抵の人は全く気にしません。記事の名前が短くなるなら、技術用語を使わないようにしてください。
   
"download managers" とするかわりに、"downloaders" とします。
+
「ダウンロードマネージャ」とするかわりに、「ダウンローダ」とします。
   
 
以下の二つを比べてみて下さい:
 
以下の二つを比べてみて下さい:
   
  +
* 他の''ダウンロードマネージャ''を使って pacman のダウンロードを高速化
* "Speed up pacman download using other ''download managers''"
 
  +
* 他の''ダウンローダ''を使って pacman のダウンロードを高速化
* "Speed up pacman download using other ''downloaders''"
 
   
 
=== 結果を見直す ===
 
=== 結果を見直す ===
98行目: 98行目:
 
焦ってはいけません。短くしたタイトルを見比べてみて意味が通っているか確認するようにしてください。
 
焦ってはいけません。短くしたタイトルを見比べてみて意味が通っているか確認するようにしてください。
   
  +
* 代わりのダウンロードマネージャを使って pacman のダウンロード速度を改善する方法
* "How to improve pacman download speed using alternative download managers"
 
  +
* 他のダウンローダを使って pacman のダウンロードを高速化
* "Speed up pacman download using other downloaders"
 
   
さて、最後の結果はかなり短いページの名前になりましたが、その意味はどうでしょうか。よい結果になったようです。しかし、今度は別の問題があります。pacman はダウンローダでは''ありません''。"alternative download managers" "other downloaders" は両方とも pacman がダウンローダ''である''と暗示していて、望んだ結果ではありません。"external downloaders" と言い換えて意味を変える必要があります。
+
さて、最後の結果はかなり短いページの名前になりましたが、その意味はどうでしょうか。よい結果になったようです。しかし、今度は別の問題があります。pacman はダウンローダでは''ありません''。「代わりのダウンロードマネージャ」「他のダウンローダ」は両方とも pacman がダウンローダ''である''と暗示していて、望んだ結果ではありません。「外部のダウンローダ」と言い換えて意味を変える必要があります。
   
 
以下を比べてみて下さい:
 
以下を比べてみて下さい:
   
  +
* ''代わりの''ダウンロードマネージャを使って pacman のダウンロード速度を改善する方法
* "How to improve pacman download speed using ''alternative'' download managers"
 
  +
* ''他の''ダウンローダを使って pacman のダウンロードを高速化
* "Speed up pacman download using ''other'' downloaders"
 
  +
* ''外部の''ダウンローダを使って pacman のダウンロードを高速化
* "Speed up pacman download using ''external'' downloaders"
 
  +
  +
== 翻訳されたページ ==
  +
  +
'''英語以外の名前は言語の識別子をつける必要があります。'''
  +
  +
管理と言語間リンクを容易にするために、英語以外のページは "Title in English (Language)" の形式のタイトルを使う必要があり、ここでの "Language" はその言語のその言語でのつづりです。ローカライズされたタイトルからのリダイレクトは作成することができ、また利便性のために作成するべきです。詳細は [[ヘルプ:i18n]] を参照してください。
  +
  +
=== 例 ===
  +
  +
例えば、[[:en:pacman]] という名前のページがあったら、イタリア語への翻訳は [[:en:pacman (Italiano)]]、韓国語への翻訳は [[:en:pacman (한국어)]]、セルビア語への翻訳は [[:en:pacman (Српски)]] という名前のページにします。

2020年11月20日 (金) 12:37時点における版

関連記事

Wiki の作成・編集において記事の命名は最も重要な仕事の一つです。この記事は記事の名前を選ぶときの完全なガイドラインであり、ArchWiki を作成・編集するときに考えるべき問題を提示しています。

記事の名前について

記事の名前には2つの用途があります。ArchWiki サイトの wiki コンテンツの識別子であると同時に、読者が中身を見分ける手段でもあります。したがって、記事の名前は一意であり、分かりやすいものにしなくてはなりません。

ときどき、記事の名前にはコンテンツのタイプが反映されることがあり、記事が書かれている言語などの情報が加えられることもあります。

記述的な名前

名前はできるかぎり具体的に、記事が扱っている範囲が何なのか分かるようにしてください。

新聞やニュースサイトに掲載されるようなソフトウェア・ハードウェアのレビューとドキュメントプロジェクトは違います。ドキュメントが読まれるのは普通、何か問題が起こったときや特定の要件を満たす必要が出てきたときです。したがって、何が必要なのかすぐに確認できて、さっと解決できることが一番重要です。可読性を高めつつ情報にすぐたどり着けるように、記事の名前 (タイトル) は記述的で、記事の中身をはっきり示すものである必要があります。

サンプル

「pacman の高速化」のようなタイトルは読者を勘違いさせてしまう可能性があります。ユーザーは pacman の「何か」を高速化させる記事だと考えるでしょうが、記事の内容が思っていたものと同じだとは必ずしも限りません。したがって、記事の名前はできるだけ分かりやすくそれでいて長くなりすぎないようにしてください。例として出した記事の名前は「wget, snarf, lftp などを使って pacman のダウンロード速度を改善する方法」と具体的にすることができます。

記事の追記の余地を残す

将来的に記事のコンテンツを追加できるように普遍的な名前を使ってください。

今後の編集や改善の余地を残すために、ときとして記事の名前はあまり限定的にしないほうが良いことがあります。もちろん、記事の名前を短くするためだけに具体的な情報を削るのはよろしくありません。一方で、主だったことは全て記述されていて、将来的に記事の扱う範囲が広がることがないのであれば、記事の名前はできるだけ具体的にしたほうが良いでしょう。

サンプル

前の例に戻ってみましょう。新しい記事のタイトルは「wget, snarf, lftp などを使って pacman のダウンロード速度を改善する方法」です。しかしながら、新しいダウンロードマネージャが登場して wget, snarf, lftp などを置き換える日がいつか来るかもしれません。したがって記事の名前をもう少し普遍的なものに変えます:「代わりのダウンロードマネージャを使って pacman のダウンロード速度を改善する方法」。

記事の名前は短くする

名前はできるかぎり短くしてください。

記事のリストをすばやく一瞥できるように記事の名前は短くしてください。ほとんどの人は wiki を読むときブラウズテクニックを使うので、長々とした名前を記事に付けると無駄に時間を浪費させることになります。また、短い名前はプロフェッショナルっぽく聞こえます。

以下では「代わりのダウンロードマネージャを使って pacman のダウンロード速度を改善する方法」という名前を例として使っています。

名前を短くするテクニックを全て挙げることはできません。使用できるテクニックは他にもたくさんありますが、とりあえずタイトル編集の「概念」を理解するには役立つでしょう。

ノート: 記事のタイトルを直訳することはときとして困難です。言語にあわせて相応しいタイトルを考えてください。英語以外のテクニックが必要となることもあります。

質問形式の名前は使わない

「改善する方法」とするかわりに、シンプルに「改善」としてください。

以下の二つを比べてみて下さい:

  • 代わりのダウンロードマネージャを使って pacman のダウンロード速度を改善する方法
  • 代わりのダウンロードマネージャを使って pacman のダウンロード速度を改善

長い語句は言い換える

「ダウンロード速度を改善」という文章は冗長です。代わりに、「ダウンロードを高速化」とします。

以下の二つを比べてみて下さい:

  • 代わりのダウンロードマネージャを使って pacman のダウンロード速度を改善
  • 代わりのダウンロードマネージャを使って pacman のダウンロードを高速化

装飾的な語句は避ける

装飾的な語句(例えば前の例では「代わり」)だけが装飾的ではありません。それらの語句は普通の語句に比べてあまり使われず、長い傾向にあります。日常的に使う語句はほとんどの場合短いことが知られています。一般的な代わりの語句を探してみてください。

「代わり」と言う代わりに、「他」と言うことができるかもしれません。

以下の二つを比べてみて下さい:

  • 代わりのダウンロードマネージャを使って pacman のダウンロードを高速化
  • 他のダウンロードマネージャを使って pacman のダウンロードを高速化

正式な技術的表現からの逸脱

技術に精通しているユーザーからは賛成されないかもしれませんが、大抵の人は全く気にしません。記事の名前が短くなるなら、技術用語を使わないようにしてください。

「ダウンロードマネージャ」とするかわりに、「ダウンローダ」とします。

以下の二つを比べてみて下さい:

  • 他のダウンロードマネージャを使って pacman のダウンロードを高速化
  • 他のダウンローダを使って pacman のダウンロードを高速化

結果を見直す

焦ってはいけません。短くしたタイトルを見比べてみて意味が通っているか確認するようにしてください。

  • 代わりのダウンロードマネージャを使って pacman のダウンロード速度を改善する方法
  • 他のダウンローダを使って pacman のダウンロードを高速化

さて、最後の結果はかなり短いページの名前になりましたが、その意味はどうでしょうか。よい結果になったようです。しかし、今度は別の問題があります。pacman はダウンローダではありません。「代わりのダウンロードマネージャ」と「他のダウンローダ」は両方とも pacman がダウンローダであると暗に示していて、望んだ結果ではありません。「外部のダウンローダ」と言い換えて意味を変える必要があります。

以下を比べてみて下さい:

  • 代わりのダウンロードマネージャを使って pacman のダウンロード速度を改善する方法
  • 他のダウンローダを使って pacman のダウンロードを高速化
  • 外部のダウンローダを使って pacman のダウンロードを高速化

翻訳されたページ

英語以外の名前は言語の識別子をつける必要があります。

管理と言語間リンクを容易にするために、英語以外のページは "Title in English (Language)" の形式のタイトルを使う必要があり、ここでの "Language" はその言語のその言語でのつづりです。ローカライズされたタイトルからのリダイレクトは作成することができ、また利便性のために作成するべきです。詳細は ヘルプ:i18n を参照してください。

例えば、en:pacman という名前のページがあったら、イタリア語への翻訳は en:pacman (Italiano)、韓国語への翻訳は en:pacman (한국어)、セルビア語への翻訳は en:pacman (Српски) という名前のページにします。