「ヘルプ:効果的な見出し」の版間の差分

提供: ArchWiki
ナビゲーションに移動 検索に移動
(en:Help:Effective use of headersへの転送ページ)
 
(TranslationStatus を末尾に移動)
 
(2人の利用者による、間の27版が非表示)
1行目: 1行目:
  +
[[Category:ヘルプ]]
−
#redirect[[en:Help:Effective use of headers]]
  
  +
[[en:Help:Effective use of headers]]
  +
[[es:Help:Effective use of headers]]
  +
[[pt:Help:Effective use of headers]]
  +
{{Related articles start}}
  +
{{Related|ヘルプ:記事命名ガイドライン}}
  +
{{Related|ヘルプ:記事の書き方}}
  +
{{Related|ヘルプ:編集}}
  +
{{Related|ヘルプ:スタイル}}
  +
{{Related articles end}}
  +
この記事は wiki の作者や編集者を対象にかかれており、実用的な記事を作成して ArchWiki の読者に見聞を広めるのを補助します。
  +
  +
この記事を読むのに wiki ページを編集する方法を知る必要はありません。[[ヘルプ:編集|技術的な編集ハウツー]]よりも、もっと全般的なスタイルガイドです。
  +
  +
== 記事の見出しについて ==
  +
  +
見出しは新しいセクションの始まりを示します。セクションはツリーの形で、他のセクションの中に配置することができます。セクションの構造を反映させるために、見出しは複数の書き方があります。セクションとその対応する見出しは、他のセクションとの相対的な位置によってレベル分けされます。
  +
  +
=== この記事で使用する用語 ===
  +
  +
他のセクションに''含まれている''セクションは、その''コンテナ''(または''親'')よりも''低レベル''と呼ばれます。つまり親は''高レベル''ということです。
  +
  +
それぞれの見出しと、同じレベルの次の見出しまでを表わすテキストは、''ヘディング''と呼ばれます。
  +
  +
ヘディングはツリーの中でのレベルを表現する''番号''を持っています。'''高いレベルのヘディングは小さい番号'''で、その逆も同じです。例えば、ArchWiki でのページのタイトルは''ヘディングレベル1''です。
  +
  +
=== 見出しの使用 ===
  +
  +
見出しとヘディングはいくつかの重要な目的のために使われます。
  +
  +
* より情報を吸収できるように読者の読む速度を下げる
  +
* ページの一部を論理的なグループにまとめる
  +
* 重要なテキストであることを示す
  +
  +
==== 読者の足を止めさせる ====
  +
  +
読者にトピックを導入するとき、短いページでも読むのにある程度の時間が必要であることを知っている必要があります。見出しは、それに続くセクションを読む前に読者の読む速度を下げる緩衝材として機能します。これにより、読者に内容について考え、続くテキストを読む準備をさせることができます。
  +
  +
==== パラグラフをサブトピックにまとめる ====
  +
  +
ほとんどの場合、ページはただ1つのトピックだけにとどまらず、主要なトピックを説明して拡大するために、関連するトピックに''寄り道する''必要があるでしょう。そのような寄り道は、読者が全体をざっと読むときには混乱を招くかもしれません。そのため、そのような寄り道を知らせる必要があります。
  +
  +
==== 重要な部分を目立たせる ====
  +
  +
時々、読者はページの中で特に興味のある部分を探すため、目次だけを見たいかもしれません。見出しだけを見るかもしれません。どちらの場合も、明確に書かれた見出しはページの重要なセクションを見つけるのに役立ちます。さらに、目次は自動で生成され、ページ内のヘディングをリストアップします。
  +
  +
=== 見出しと目次 ===
  +
  +
ページの目次は、2つ以上の見出しがあるときに自動で生成されます。目次を隠すには、ページのどこかに次のコードの行を追加する必要があります。
  +
  +
<nowiki>__NOTOC__</nowiki>
  +
  +
== 見出しのレベルについて ==
  +
  +
ヘディングのレベルについて、いくつか重要なことがあります。
  +
  +
=== 重要性が等価なら同じレベルの見出しを使う ===
  +
  +
これは文字通りだと思うかもしれませんが、見た目ほど簡単ではありません。次の例を見てください。
  +
  +
*Introduction
  +
*Step 1: Installing X
  +
*Step 2: Editing keyboard settings
  +
*Step 3: Editing mouse settings
  +
*Step 4: Editing display settings
  +
*Step 5: Adding fglrx options
  +
*Step 6: Starting X
  +
*Conclusions
  +
  +
このリストを慎重に分析すると、ステップ2から4はステップ1と6よりも重要性が低く、ステップ5は最も重要性が低いことに気付くでしょう。これらのステップが他のステップよりもテキストの量が多い・少ないということを言っているのではありません。重要なのは概念として重要かどうかです。
  +
  +
これを修正するには、以下のように変更します。
  +
  +
*Introduction
  +
*Step 1: Installing X
  +
*Step 2: Configuring X
  +
**Step 2a: Editing keyboard settings
  +
**Step 2b: Editing mouse settings
  +
**Step 2c: Editing display settings
  +
***Step 2c-1: Adding fglrx options
  +
*Step 3: Starting X
  +
*Conclusions
  +
  +
ご覧の通り、ステップ2から4を ''Configuring X'' というタイトルのヘディングに統合して、ヘディングを3つのサブヘディングに分割しました。さらに、ステップ5をステップ2cに移動して、サブヘディングに変更しました。
  +
  +
=== 一番高いレベルのヘディングは常に最高レベルにする ===
  +
  +
これも常識のように聞こえるかもしれませんが、1つの小さい問題があります。見出しにはフォーマットスタイルが当てられます。多くの人はそのフォーマットのルールをページの見た目を変えるために使ってしまいます。これは壊れたヘディングの構造を作ります。
  +
  +
次の例を見てください。
  +
  +
*Introduction
  +
*Step 1
  +
*Step 2
  +
*Step 3
  +
**Conclusion
  +
  +
このページの編集者は、レベル1のヘディングは ''Conclusion'' のような重要ではないセクションには大きすぎると思い、レベル2のヘディングを使う方がいいと考えました。これは最後のセクションが他のセクションより1レベル下であるヘディング構造の結果となります。正しい構造は以下のようになるでしょう。
  +
  +
*Introduction
  +
*Step 1
  +
*Step 2
  +
*Step 3
  +
*Conclusion
  +
  +
conclusion は他のセクションと同じレベルになりました。
  +
  +
{{Note|''Introduction'' や ''Conclusion'' といったセクションがページのメインと同じ重要性を持つことは奇妙に映るかもしれませんが、そのようなセクションは実際重要です。ページの最後に(このような)ノートを追加したり、うまくまとまっていない・欠けているセクションを完全に除外したりして、セクションを見た目の問題のためだけに低いレベルに降格することを避けた方がよいです。}}
  +
  +
== ヘディング構造のタイプ ==
  +
  +
使われているレベルの種類と目的に基づいて、ヘディング構造は以下のようなカテゴリに分類されます。
  +
  +
#1レベルだけの構造
  +
#間違った複数レベルの構造
  +
#複数レベルの構造
  +
  +
=== 1レベルだけの構造 ===
  +
  +
ページを編集するとき、一番率直な方法は複数のステップに分割することです。ステップは実際のステップである必要はなく、何か読者が取る必要のあるステップです。あるいは、編集者がページを書いていくときに取るステップかもしれません。どの場合も、ステップは連続していて、1レベルだけの構造になります。
  +
  +
このような種類のページの典型的な構成は以下のようになるでしょう。
  +
  +
*Introduction
  +
*Step 1: doing this or the other
  +
*Step 2: cleaning up
  +
*Step 3: troubleshooting
  +
*Further reading
  +
  +
これはシンプルな3つのステップの導入と、参照できるリンクです。
  +
  +
=== 間違った複数レベルの構造 ===
  +
  +
時には、シンプルで連続した1レベルだけの構造から外れる必要があります。
  +
  +
==== ノート ====
  +
  +
通常、何かを詳しく述べるためにメインの流れから少し外れる必要があるでしょう。
  +
  +
*Introduction
  +
*Step 1: doing this or the other
  +
**Notes on configuring XYZ
  +
*Step 2: cleaning up
  +
*Step 3: troubleshooting
  +
*Further reading
  +
  +
このような方法の代わりに、ノートやコメントを [[テンプレート:Note|ノートテンプレート]] で追加することを検討してください。
  +
  +
==== 補助の情報を強調する ====
  +
  +
メインの議論への追加の議論となる部分や、メインの議論を他の方法で強化するなどの重要な部分に印を付けたくなるかもしれません。
  +
  +
*Introduction
  +
*Step 1: doing this or the other
  +
**Here is the sample code
  +
*Step 2: cleaning up
  +
**Here is the sample code
  +
*Step 3: troubleshooting
  +
**Here is the sample code
  +
*Further reading
  +
  +
=== 複数レベルの構造 ===
  +
  +
複数レベルの構造は長くて詳細なページに典型的です。しかし、短いハウツーにも効果的に使えるかもしれません。
  +
  +
複数レベルの構造が便利ないくつかのケースを紹介します。
  +
  +
{{Note|ここではヘディングレベルの親子関係について記述していることと、親のレベルが1, 2, 3 であることは重要ではないことに注意してください。同じことは2か''より多くの''レベルを持つ複数レベルの構造にも適用できます。}}
  +
  +
==== 議論をグループ化する ====
  +
  +
サブヘディングは、ヘディングがページ全体に対してどんな役割をするかのメインのヘディングになることができます。
  +
  +
次のような例があります。
  +
  +
*Introduction
  +
*Step 1: doing this or the other
  +
*Step 2: cleaning up
  +
** First do this
  +
** Then do that
  +
** You're done!
  +
*Step 3: troubleshooting
  +
*Further reading
  +
  +
==== 代わりの議論 ====
  +
  +
時には、議論の対象について読者に異なる視点を与える必要があります。
  +
  +
次のような例があります。
  +
  +
*Introduction
  +
*Step 1: doing this or the other
  +
**This is one way to do it
  +
**This is another way to do it
  +
*Step 2: cleaning up
  +
*Step 3: troubleshooting
  +
*Further reading
  +
  +
==== 反対の議論 ====
  +
  +
否定的な議論について記述する必要があるのであれば、それぞれにサブヘディングを作ることができます。
  +
  +
具体的には以下のようになります。
  +
  +
*Introduction
  +
*Step 1: doing this or the other
  +
**You want this
  +
**There are reasons for not wanting this, though
  +
*Step 2: cleaning up
  +
*Step 3: troubleshooting
  +
*Further reading
  +
  +
== 見出しの文章 ==
  +
  +
ここではいくつかの鍵となる点をまとめました。より詳細な情報は、[[ヘルプ:記事命名ガイドライン]]を参照してください。ここに挙げられているものは見出しのテキストとページ名の両方に当てはまります。
  +
  +
* 見出しのテキストはできるだけ具体的で、ヘディングのスコープを反映するようにする
  +
* 見出しのテキストはヘディングを将来拡張することができるように一般的にするようにする
  +
* 見出しのテキストはできるだけ短くする([[ヘルプ:記事命名ガイドライン]]を参照)
  +
  +
== フォーマット ==
  +
  +
既に述べたように、見た目のために見出しのフォーマットスタイルを濫用''しないこと''はとても重要です。見た目が気に入らないなら、[[ArchWiki:管理者|管理者に連絡]]して意見を聞くか、ヘディング構造を維持する方法での状況の解決を依頼してください。
  +
  +
テキストをヘディングにするには、2つかそれ以上のイコール記号({{ic|1===}})を使わなければいけません。
  +
  +
{{Note|使用可能な一番低いレベルのヘディングレベルは実際は1({{ic|1==}})ですが、ページのタイトルのために''予約''されています。ページのセクションはレベル2から始めなければいけません。}}
  +
  +
見出しを示すコードは以下の通りです。
  +
  +
==Header level 2==
  +
===Header level 3===
  +
====Header level 4====
  +
=====Header level 5=====
  +
======Header level 6======
  +
  +
見出しがどのように表示されるか見たいのであれば、[[サンドボックス]]を使うことができます。
  +
  +
{{TranslationStatus|Help:Effective use of headers|2020-04-10|605265}}

2022年1月1日 (土) 12:16時点における最新版

関連記事

この記事は wiki の作者や編集者を対象にかかれており、実用的な記事を作成して ArchWiki の読者に見聞を広めるのを補助します。

この記事を読むのに wiki ページを編集する方法を知る必要はありません。技術的な編集ハウツーよりも、もっと全般的なスタイルガイドです。

記事の見出しについて

見出しは新しいセクションの始まりを示します。セクションはツリーの形で、他のセクションの中に配置することができます。セクションの構造を反映させるために、見出しは複数の書き方があります。セクションとその対応する見出しは、他のセクションとの相対的な位置によってレベル分けされます。

この記事で使用する用語

他のセクションに含まれているセクションは、そのコンテナ(または親)よりも低レベルと呼ばれます。つまり親は高レベルということです。

それぞれの見出しと、同じレベルの次の見出しまでを表わすテキストは、ヘディングと呼ばれます。

ヘディングはツリーの中でのレベルを表現する番号を持っています。高いレベルのヘディングは小さい番号で、その逆も同じです。例えば、ArchWiki でのページのタイトルはヘディングレベル1です。

見出しの使用

見出しとヘディングはいくつかの重要な目的のために使われます。

  • より情報を吸収できるように読者の読む速度を下げる
  • ページの一部を論理的なグループにまとめる
  • 重要なテキストであることを示す

読者の足を止めさせる

読者にトピックを導入するとき、短いページでも読むのにある程度の時間が必要であることを知っている必要があります。見出しは、それに続くセクションを読む前に読者の読む速度を下げる緩衝材として機能します。これにより、読者に内容について考え、続くテキストを読む準備をさせることができます。

パラグラフをサブトピックにまとめる

ほとんどの場合、ページはただ1つのトピックだけにとどまらず、主要なトピックを説明して拡大するために、関連するトピックに寄り道する必要があるでしょう。そのような寄り道は、読者が全体をざっと読むときには混乱を招くかもしれません。そのため、そのような寄り道を知らせる必要があります。

重要な部分を目立たせる

時々、読者はページの中で特に興味のある部分を探すため、目次だけを見たいかもしれません。見出しだけを見るかもしれません。どちらの場合も、明確に書かれた見出しはページの重要なセクションを見つけるのに役立ちます。さらに、目次は自動で生成され、ページ内のヘディングをリストアップします。

見出しと目次

ページの目次は、2つ以上の見出しがあるときに自動で生成されます。目次を隠すには、ページのどこかに次のコードの行を追加する必要があります。 

__NOTOC__

見出しのレベルについて

ヘディングのレベルについて、いくつか重要なことがあります。

重要性が等価なら同じレベルの見出しを使う

これは文字通りだと思うかもしれませんが、見た目ほど簡単ではありません。次の例を見てください。

  • Introduction
  • Step 1: Installing X
  • Step 2: Editing keyboard settings
  • Step 3: Editing mouse settings
  • Step 4: Editing display settings
  • Step 5: Adding fglrx options
  • Step 6: Starting X
  • Conclusions

このリストを慎重に分析すると、ステップ2から4はステップ1と6よりも重要性が低く、ステップ5は最も重要性が低いことに気付くでしょう。これらのステップが他のステップよりもテキストの量が多い・少ないということを言っているのではありません。重要なのは概念として重要かどうかです。

これを修正するには、以下のように変更します。

  • Introduction
  • Step 1: Installing X
  • Step 2: Configuring X
    • Step 2a: Editing keyboard settings
    • Step 2b: Editing mouse settings
    • Step 2c: Editing display settings
      • Step 2c-1: Adding fglrx options
  • Step 3: Starting X
  • Conclusions

ご覧の通り、ステップ2から4を Configuring X というタイトルのヘディングに統合して、ヘディングを3つのサブヘディングに分割しました。さらに、ステップ5をステップ2cに移動して、サブヘディングに変更しました。

一番高いレベルのヘディングは常に最高レベルにする

これも常識のように聞こえるかもしれませんが、1つの小さい問題があります。見出しにはフォーマットスタイルが当てられます。多くの人はそのフォーマットのルールをページの見た目を変えるために使ってしまいます。これは壊れたヘディングの構造を作ります。

次の例を見てください。

  • Introduction
  • Step 1
  • Step 2
  • Step 3
    • Conclusion

このページの編集者は、レベル1のヘディングは Conclusion のような重要ではないセクションには大きすぎると思い、レベル2のヘディングを使う方がいいと考えました。これは最後のセクションが他のセクションより1レベル下であるヘディング構造の結果となります。正しい構造は以下のようになるでしょう。

  • Introduction
  • Step 1
  • Step 2
  • Step 3
  • Conclusion

conclusion は他のセクションと同じレベルになりました。

ノート: Introduction や Conclusion といったセクションがページのメインと同じ重要性を持つことは奇妙に映るかもしれませんが、そのようなセクションは実際重要です。ページの最後に(このような)ノートを追加したり、うまくまとまっていない・欠けているセクションを完全に除外したりして、セクションを見た目の問題のためだけに低いレベルに降格することを避けた方がよいです。

ヘディング構造のタイプ

使われているレベルの種類と目的に基づいて、ヘディング構造は以下のようなカテゴリに分類されます。

  1. 1レベルだけの構造
  2. 間違った複数レベルの構造
  3. 複数レベルの構造

1レベルだけの構造

ページを編集するとき、一番率直な方法は複数のステップに分割することです。ステップは実際のステップである必要はなく、何か読者が取る必要のあるステップです。あるいは、編集者がページを書いていくときに取るステップかもしれません。どの場合も、ステップは連続していて、1レベルだけの構造になります。

このような種類のページの典型的な構成は以下のようになるでしょう。

  • Introduction
  • Step 1: doing this or the other
  • Step 2: cleaning up
  • Step 3: troubleshooting
  • Further reading

これはシンプルな3つのステップの導入と、参照できるリンクです。

間違った複数レベルの構造

時には、シンプルで連続した1レベルだけの構造から外れる必要があります。

ノート

通常、何かを詳しく述べるためにメインの流れから少し外れる必要があるでしょう。

  • Introduction
  • Step 1: doing this or the other
    • Notes on configuring XYZ
  • Step 2: cleaning up
  • Step 3: troubleshooting
  • Further reading

このような方法の代わりに、ノートやコメントを ノートテンプレート で追加することを検討してください。

補助の情報を強調する

メインの議論への追加の議論となる部分や、メインの議論を他の方法で強化するなどの重要な部分に印を付けたくなるかもしれません。

  • Introduction
  • Step 1: doing this or the other
    • Here is the sample code
  • Step 2: cleaning up
    • Here is the sample code
  • Step 3: troubleshooting
    • Here is the sample code
  • Further reading

複数レベルの構造

複数レベルの構造は長くて詳細なページに典型的です。しかし、短いハウツーにも効果的に使えるかもしれません。

複数レベルの構造が便利ないくつかのケースを紹介します。

ノート: ここではヘディングレベルの親子関係について記述していることと、親のレベルが1, 2, 3 であることは重要ではないことに注意してください。同じことは2かより多くのレベルを持つ複数レベルの構造にも適用できます。

議論をグループ化する

サブヘディングは、ヘディングがページ全体に対してどんな役割をするかのメインのヘディングになることができます。

次のような例があります。

  • Introduction
  • Step 1: doing this or the other
  • Step 2: cleaning up
    • First do this
    • Then do that
    • You're done!
  • Step 3: troubleshooting
  • Further reading

代わりの議論

時には、議論の対象について読者に異なる視点を与える必要があります。

次のような例があります。

  • Introduction
  • Step 1: doing this or the other
    • This is one way to do it
    • This is another way to do it
  • Step 2: cleaning up
  • Step 3: troubleshooting
  • Further reading

反対の議論

否定的な議論について記述する必要があるのであれば、それぞれにサブヘディングを作ることができます。

具体的には以下のようになります。

  • Introduction
  • Step 1: doing this or the other
    • You want this
    • There are reasons for not wanting this, though
  • Step 2: cleaning up
  • Step 3: troubleshooting
  • Further reading

見出しの文章

ここではいくつかの鍵となる点をまとめました。より詳細な情報は、ヘルプ:記事命名ガイドラインを参照してください。ここに挙げられているものは見出しのテキストとページ名の両方に当てはまります。

  • 見出しのテキストはできるだけ具体的で、ヘディングのスコープを反映するようにする
  • 見出しのテキストはヘディングを将来拡張することができるように一般的にするようにする
  • 見出しのテキストはできるだけ短くする(ヘルプ:記事命名ガイドラインを参照)

フォーマット

既に述べたように、見た目のために見出しのフォーマットスタイルを濫用しないことはとても重要です。見た目が気に入らないなら、管理者に連絡して意見を聞くか、ヘディング構造を維持する方法での状況の解決を依頼してください。

テキストをヘディングにするには、2つかそれ以上のイコール記号(==)を使わなければいけません。

ノート: 使用可能な一番低いレベルのヘディングレベルは実際は1(=)ですが、ページのタイトルのために予約されています。ページのセクションはレベル2から始めなければいけません。

見出しを示すコードは以下の通りです。 

==Header level 2==
===Header level 3===
====Header level 4====
=====Header level 5=====
======Header level 6======

見出しがどのように表示されるか見たいのであれば、サンドボックスを使うことができます。

翻訳ステータス: このページは en:Help:Effective use of headers の翻訳バージョンです。最後の翻訳日は 2020-04-10 です。もし英語版に 変更 があれば、翻訳の同期を手伝うことができます。
「https://wiki.archlinux.jp/index.php?title=ヘルプ:効果的な見出し&oldid=23009」から取得