Wiki には、さまざまな記述方法があります。このトピックでは Wiki を記述する上での最良の方法を説明します。

記事にするアイディアを見つけるには、こちらを参照してください。

素晴らしい記事を作成するには

素晴らしい Wiki の記事は、読者が必要とする 1 つや複数の貴重な情報を、タイトルや最初の段落で示します。特別な環境において確実な機能を展開する方法を説明する場合には、記事では環境の説明を簡潔に行い、事前の状態やリストでの手順、最終的な完了状態を、読者がタスクを完了するために必要とされるような図表や動画、その他助けとなる要素を用いるべきです。

素晴らしい記事を作成するために

  • 共有したい 1 つか 2 つのキーとなる情報を見極めてください
  • 記事のタイトルに、キーとなる言葉を含めてください。以下は例です。
    英語 日本語
    How to < 動詞 > the < ナゲット > < ナゲット > を < 動詞 > するには
    Troubleshooting < ナゲット > < ナゲット > のトラブルシューティング
    Connecting < ナゲット > to < 他の製品 > < ナゲット > の < 他の製品 > への接続
    Getting started with < ナゲット > < ナゲット > を始めるにあたって
  • 最初の段落で記事の目的や見込みを記述してください。64bit マシンを利用したクラスター環境への SQL Server 2008 のインストールの検査であったり、2 つの機能間の特色について記述すること、他の何かを通して API 関数を呼び出すことについての賛否を議論すること、製品や機能のためのトラブルシューティングのステップを提供すること、ある実装の一般的な機能について議論することを記述してもらえますか ? 読者は何を書こうとしているのかを知りたがります
  • 簡潔に記述してください。長文記事は良い記事ではありません。もしキーとなる言葉を 20 語で提供できるのであれば、それはもう 20 語で充分です。
  • 自分のスタイルで記述してくださいただ、明瞭さを犠牲にしてはいけません。私たちは誰もロボットではありません。自分のスタイルで記述してください。ただ、言おうとしていることが何であるかについてぼやけないようにしてください。キーとなる情報を崩さないでください
  • タイトルと本文に重要な情報についてのキーワードを入れるようにしてください。検索エンジンの最適化担当者は、利用されるキーワードについてのみ知っていて、想像で対応してくれはしません。
  • 必要な個所にリファレンスを提供してください。リファレンスは、信憑性や出典、異なる視点、詳細内容の追加を提供し、たびたび記事の評判を向上させてくれます。
  • 意見を述べてください。特定の展開ソリューションを好む場合、あなたが見つけた選択肢と、なぜそれを選択したのかを説明するようにしてください。他から API 関数を呼び出す方法は 1 つしかありませんか ? それは何故なのか教えてください ! 試したが上手く動かなかった内容について教えてください。あなたにとっては役に立たないかもしれませんが、私たち、そして読者は知りたいと思っています
  • 助けを&#38972;ってください。追加のシナリオやスクリプト、その他の情報を望むならば、そのように知らせましょう。
  • 記事は大胆に作成し、穏やかに編集してください。あなたは記事の作成者かもしれませんが、一度公開されるとそれはコミュニティが所有することになります。文字の綴りや文法が完璧ではなくても、やがてコミュニティが段階的に修正していきます。
  • 記事をつなげてください。適切な場所で、アクセスを簡単にするためにあなたの記事からリンクを張るようにしてください。

記事の種類

記事は必要に応じてさまざまな種類の内容を記述することができます。ここにいくつかの種類を示します。

  • 議論。この種類の記事は、異なるオプションや、見解、視点を示します。もし読者がいくつかの点で同意できないような場合、既存の見解に対する " 変わった見解 " として、自身の考えや認識について追記します。全ての考え方を示すことがゴールです。
  • 概略。その目的は製品や手法、一般的なコンセプトなどの基礎的な概要を提供することです。サブセクションの記述量が多くなってきたなら、新しい記事を作成してその記事へのリンクを付けるようにします。
  • 方法。この種類の記事では、出来る限り簡単かつ明瞭に何かを実行する方法を説明します。例 : 記事に動画や画像を追加するには
  • スタブ。これから拡張が必要な短い記事です。( スタブページを作成するには ) 。記事の全ての内容を記述するための時間や知識が十分でないかもしれないが、今後自身で完成させるつもりであったり、コミュニティが完成させてくれることを希望する場合に利用します。
  • リンクコレクション。数多くのリンクから成る記事です。これは Wiki ポータルのような ( TechNet Wiki の他のトピックへの全てのリンクを集めた ) ものや、外部リンクへのコレクション ( や、その両方 ) となります。リンクが他の Wiki 記事であるかどうかを明確にするようにしてください。例 : はじめに技術ポータル
  • トラブルシューティング。特定の製品やインターフェースに影響する一般的な問題に対する解決方法のリストです。

関連項目

他の言語