DokuWiki

It's better when it's simple

ユーザ用ツール

サイト用ツール


サイドバー

この翻訳は元のページよりも更新日が古く、内容が古い可能性があります。 変更点を参照して下さい。
このページの翻訳?:

DokuWiki について知る

開発

法人利用

我々のコミュニティ


FacebookTwitterや他のソーシャル・ネットワークからフォローしてください。

ja:tips:good_style

良いスタイルのヒント

以下に、良い Wiki ページを作成するためのヒントをいくつか示します。

ページの構造

  • ページは、意味のあるタイトルを持つ第一レベル見出しで始めましょう。
  • 見出しレベルは正しい順番でネストしましょう。第二レベルのセクションは第二レベルの見出しで開始しましょう。
  • ひとまとまりの文章を段落とし、段落は空行で区切って分割しましょう。平均的な段落は 10 ~ 20 行を超えないようにしましょう。
  • もしテキストの量が 3 ~ 5 段落を超える場合は、第二レベルから第五レベルまでのセクションに分割することを検討しましょう。
  • もしテキストの量が 2 ~ 3 画面を超える場合は、第一レベル見出しの後にページ内容の要約を付けましょう。ページが非常に長くなる場合は、複数のページに分割することも検討しましょう。
  • 他の Wiki ページや外部サイトへのリンクが大量にある場合は、追加の参考文献用の特別なセクションを追加しましょう (下記の参考文献も参照してください)。
  • 名前空間内のほとんどのページが共通の構造を持つ場合は、名前空間テンプレートを追加し、新規ページ構造の雛形から編集を開始できるようにしましょう。
  • 複雑すぎる名前空間の構造はなるべく避けましょう。名前空間には、短くて覚えやすい名前を使うようにしましょう。

テキストの書式設定

  • 単語や短い句の強調には、太字もしくは斜体を使います。どちらか 1 つを選択し、それだけを使うようにしましょう。
  • ボタンやメニューラベルのような画面出力と画面上のテキストの表示スタイルを選択し、それを一貫して使用するようにしましょう。Wiki のスタイル規約の説明ページを追加することも良いアイデアかもしれません。
  • 番号なしリストは、それぞれが独立している説明に対して使用しましょう。
  • 脚注は非常に短い追加コメントのためだけに、控えめに使用しましょう。もし特定の話題について説明することがもっとたくさんある場合は、新しい Wiki ページを作成してそこに記載してください。もし他の (外部の) 情報リソースを参照したい場合は、リンクを使用しましょう。
  • 表は構造化されたデータの読みやすさを大きく向上させることができます。もし表を挿入する場合は、必ず意味のあるセル見出しを付け、表の内容を明確に述べた表題を提供するようにしてください。
  • 大きな表は、編集がとても難しくなりがちです。代わりにそのデータをネストしたリストで表現することも検討しましょう。

言葉遣い

(訳注: 一部の項目は英語向けのヒントのようです)

  • きちんとした文章を書き、必要であれば名詞に冠詞を使用しましょう。
  • それぞれの文章は大文字で始め、ピリオドもしくはその他の適切な句読点で終えるようにしましょう。
  • 従属節にはあまり頼らず、短く明確な文章を書くように心がけましょう。ページを書き終えたと思った時にはもう一度読み直し、構造があまりにも複雑な文章は修正しましょう。
  • 読者に語りかける方法を決めましょう。DokuWiki はドキュメント作成向けに調整されているため、何かを行う方法を読者に対して指示しなければならないこともよくあるでしょう。形式としては、命令形 (「これをしなさい!」)、私たち・あなたの形式 (「それから私たち・あなたはクリックします……」)、の形式 (「次には……を使用して foo を bar に追加します」) などを使うことができます。これらの形式は混ぜないようにしましょう。
  • ページを保存する前に、文法間違いおよびスペルミスが無いかどうかを確認しましょう。もし文章にたくさんの間違いがある場合は、あなたが記述したことがどんなに熟慮された内容であったとしても、その信頼性は低下してしまうでしょう。
  • あなた自身のスタイルを見つけましょう。心地よく書けない方法を自分に強制することはやめてください。そのような方法は不自然なだけに思われますし、読むのも不愉快になってしまいます。

参考文献

  • もっと説明が必要な用語を見つけた場合は、その用語のために新しい Wiki ページを追加し、そこにリンクしましょう。
  • ページを保存する前に再確認し、ページ内の重要な用語には既存の Wiki ページへのリンクを追加しましょう。
  • 特定の用語が出現する度にリンクを付けるのはやめましょう。ページ内での最初の出現、もしくは一番目立つ位置で出現するものだけにリンクを付けましょう。あるいは参考文献セクションにリンクを追加するのもよいかもしれません。
  • 画像、データ、引用文については、出典へのリンクを提供しましょう。
  • ページの最後に「関連項目」を追加することも検討しましょう。そのページの話題に密接に関連している Wiki ページへのリンクを提供しましょう。
  • 話題に関するさらなる情報を持つ、あるいはページ内に記載した外部リソースへのポインタを提供したい場合は、ページの最後に「参考文献」もしくは「さらなる情報」といったセクションを追加し、リンクやその他のポインタ (例えば ISBN 番号など) のリストを提供しましょう。もしまだ本文内にこのようなセクションを追加していない場合は、参照の意図を提示しておきましょう。
  • InterWiki ショートカットを設定しておくと、よくあるリソースへリンクする際に役立ちます。

画像とその他のメディア

  • 『百聞は一見にしかず』画像は、あなたが伝えようと意図した以上に意味を持つ可能性があります。人間は、画像の信憑性を言葉よりも疑問視しない傾向があります。短いテキスト記述は、何も無い場合よりも、不正確な画像よりも、はるかにましです。
  • 表と同様に、画像に対してもその画像で示したいことを述べた表題を常に提供するようにしましょう。
  • 自分で作成した画像でない場合は、出典 (場合によってはリンク付きで) と著作権を明記しましょう。
  • 明確に許可されている場合を除き、外部サイトの画像にはリンクしないようにしましょう。これはまず第一に著作権の問題がありますが、設定項目: fetchsize が無効になっている場合はその外部サイトの帯域幅の盗用という問題もあります。
  • もし画像が画面表示範囲の約 1/3 よりも大きい場合は、サムネイルを掲載するためにリサイズ指定のリンク構文を使用しましょう。
ja/tips/good_style.txt · 最終更新: 2011-09-15 10:32 by ach