ウィキペディア:技術記事を理解できるようにする

ウィキペディアから、無料の百科事典
ナビゲーションにジャンプ 検索にジャンプ

ウィキペディアの記事の内容は、できるだけ多くの一般の読者のために可能限り書かれるべきです

コンテンツを追加したり、新しい記事を作成したりするときは、フォーマルなトーンの百科事典的なスタイルが重要です。ウィキペディアの記事は、エッセイのような、論争的な、または意見のある文章ではなく、わかりやすく、事実に基づいたスタイルにする必要があります。資料が可能な限り最も広く理解できる方法で提示されるように、あらゆる合理的な試みを行う必要があります。記事が高度に技術的な方法書かれているが、その資料がより理解しやすい説明を許可している場合、編集者はそれを書き直すことを強くお勧めします。

観客

ウィキペディアには、次の3つの方法で評価できるさまざまな対象者がいます。

  • 主題に精通していることについて。
    • 一般的な読者は、トピックのフィールドには、高度な教育を受けていないトピック自体に大幅に不慣れで、さらに話題が何であるかわからないかもしれません。
    • 知識のある読者は、トピックの分野での教育を持っていますが、話題そのものについて学びたいです。
    • 専門家の読者は、トピックを知っているが、より多くを学ぶためにまたはいくつかの事実について思い出したことが望んでいる、またはウィキペディアの報道について興味があります。
  • 読解力について。様々な無料オンラインツールが自動的にグレードテキストの読みやすさなどの複雑な文構造、強調表示することができhttp://www.hemingwayapp.com自動化された読みやすさの指標)またはhttp://www.readabilityofwikipedia.comフレッシュの読み取りやすさを)。
  • トピックについて学ぶ動機によって。

高度な教育を受け、知識が豊富で、やる気のある読者は、5,000語の特集記事を最後まで快適に読むことができます。別の読者は、リードを介して苦労し、写真を見る可能性があります。良い記事は、すべての読者の興味を引き、彼らができる限り、そしてやる気のある主題について多くを学ぶことを可能にします。記事は、読者の読解力をはるかに超えて書かれているため、読者が主題や分野に精通していると誤って想定しているため、またはトピックを基本的なレベルにまでカバーしている、または包括的でないため、失望する可能性があります。

いずれかのオーディエンスグループのメンバーが記事に出くわし、それを読むことを決定する場合がありますが(たとえば、Special:Randomをクリックすることにより)、一部の主題は当然、より限定されたオーディエンスを引き付けます。研究または議論される前に何年もの専門家の教育または訓練を必要とするトピックは、一般に、より限られた聴衆を持っている可能性があります。たとえば、高度な数学、専門法、または工業工学のトピックには、知識のある読者だけが理解できる、または理解できる資料が含まれている場合があります。一方で、学術的に進んだレベルで研究された多くの科目は、より多くの聴衆に関心を持っています。たとえば、太陽は天文学者だけでなく、アルツハイマー病にも関心があります。 医師だけでなく興味を引くでしょう。

ほとんどのウィキペディアの記事は、平均的な読解力とモチベーションを備えた一般の読者が完全に理解できるように書くことができます。一部の記事はそれ自体が技術的な性質のものであり、一部の記事には技術的なセクションまたは側面があります。これらの多くは、まだ幅広い聴衆に理解できるように書くことができます。一部のトピックは本質的に複雑であるか、専門教育またはトレーニングを通じて得られた多くの事前知識を必要とします。そのような主題に関する包括的な記事がすべての読者に理解できると期待することは不合理です。リードセクションに特に重点を置いて、記事をできるだけ多くの人に理解できるようにするための努力を引き続き行う必要があります。記事は、専門家でない人でも正しく理解できる簡単な英語で書かれている必要があります。

技術コンテンツ支援

ウィキペディアは真剣な参考資料となるよう努めており、高度に技術的な主題は依然として一部のウィキペディアの記事に含まれています。技術的な内容の理解度を高めることは、知識の少ない読者の利益のために記事を改善することを目的としていますが、これは、より技術的な背景を持つ読者にとっての価値を低下させることなく行う必要があります。

記事をより理解しやすくすることは、必ずしも詳細な技術的内容を削除する必要があることを意味するわけではありません。たとえば、化合物に関する百科事典の記事には、一般の読者にはわかりにくい特性がある場合でも、化合物の特性が含まれていると予想されます。しかし、多くの場合、高度に技術的な詳細を要約すると、一般の読者と専門家の両方にとってテキストの読みやすさが向上します。たとえば、ある結果の長々とした数学的証明は、一般の読者や専門家のどちらにも読まれない可能性がありますが、証明の短い要約とその最も重要なポイントは、有用性を損なうことなく一般の読者に意味を伝えることができます専門家の読者に。含めるのに適切な技術的詳細の量を決定しようとするとき、記事の主題が属する特定の技術分野の標準的な参考書と比較すると役立つ場合があります。

リードセクション

最初のセクション(目次の上の「リード」セクション)が幅広い読者に理解できることが特に重要です。読者は、トピックの詳細をまだ知らなくても、記事の内容と正しい記事を読んでいるかどうかを知ることができる必要があります。要約または一般的な定義のみを探している人は、リードの終わりで読むのをやめるかもしれません。理解しやすいリードは、読者が記事の本文を読み続けることを奨励します。

これらの理由から、リードは記事のわかりやすい概要を提供する必要があります。リードはトピックのすべての重要な側面に何らかの方法で言及することを目的としていますが、アクセシビリティは、リードのトピックを要約し、記事の本文に技術的な詳細を含めるだけで改善できます。記事のリードは、一般の読者にトピックの研究分野、トピックがその研究分野で保持する場所、トピックが何に適しているか、そして何を最初に学ぶ必要があるかを伝える必要があります記事を理解します。

一般に、リードは、読者が記事の主題に精通していると想定するべきではありません。一般の聴衆がなじみのある概要を説明することが難しい高度に専門化されたトピックについては、それを理解するために必要な前提条件にリンクしながら、リードの背景知識をある程度想定することが合理的かもしれません。

経験則

中程度または高度に技術的な主題を扱うためのいくつかのアイデアがあります。

記事の最も目立たない部分を前に置いてください

必要に応じて、後のセクションをより技術的にすることはまったく問題ありません。詳細に興味がない人は、ある時点で読むのをやめるだけです。そのため、興味のある資料最初に読む必要があります。記事のリンクされたセクションは、理想的には同様の技術レベルで開始する必要があります。これにより、記事の最初の簡単な段落が記事の途中のセクションにリンクする場合、リンクされたセクションの最初の部分も理解できるようになります。さらに、詳細に入る前に最初の段落の主要なアイデアを要約することで、さらに技術的なセクションを改善できることがよくあります。

循環的な説明は避けてください。AをBで定義し、BをAで定義しないでください。定義する、専門用語が使用されていないことを確認してください

1レベル下に書く

アクセシビリティを向上させるための一般的な手法は、トピックが研究される典型的なレベル(たとえば、中等学部、または大学院)を検討し、前のレベルの読者向けに記事を書くことです。したがって、学部のトピックに関する記事は、中等学校のバックグラウンドを持つ読者を対象とすることができ、大学院のトピックに関する記事は、学部のバックグラウンドを持つ読者を対象とすることができます。リードセクションは特に理解しやすいはずですが、1レベル下に書くというアドバイスを記事全体に適用して、全体的なアクセシビリティを向上させることができます。 1レベル下に書くことは、読者がそれに関する他の情報源を読み始める前に使用できる、トピックに関する三次情報源を提供するという私たちの目標もサポートします。

具体的な例を追加

多くの技術記事は、抽象的であるという理由だけで理解できません(そして専門家の読者にとってさえさらに混乱します)。具体的な例は、多くの読者が抽象的なコンテンツをコンテキストに入れるのに役立ちます。対照的な例(反例)も役立つ場合があります。たとえば、冠詞の動詞から

動詞ラテン語から、verbum意味の単語は、ある単語品詞であること)構文アクションを伝える(持参読み歩行走行学ぶ)、発生(起こるとなって)、または(ある状態存在スタンド)。

例は、他のコンテンツが対象とする独自の調査ないという同じ要件を満たしている必要があります。

英語で数式を説明する

可能であれば、専門家であっても、数式に特定の機能がある理由や特定の方法で記述されている理由を英語で説明すると役立つ場合があります。数式の「意味」を説明することは、読者が従うのに役立ちます。少なくとも、数式のすべての変数が記事で定義されていること、またはそれらを説明する記事へのリンクがあることを確認してください。

写真を追加

視覚的な描写により、多くの人々がより効果的に学習できるようになり、技術的な概念をより簡潔かつ明確に伝えることができます。ダイアグラムは、必要に応じて、記号または口頭での説明に関連付ける必要があります。役に立つかもしれないいくつかのテンプレート:

  • {{Location map}}:1つの画像シンボル+ラベルを地図/画像にオーバーレイします。
  • {{Location map many}}:多くの画像シンボルとラベルをマップ/画像にオーバーレイします(最大9個のマーカー)。
  • Module:Location map/data/100x100:100行100列のオーバーレイグリッドとしての画像の例があります。
  • {{Superimpose}}:開いている図など、境界のない画像にオーバーレイします。

過度に専門的な言葉は避けてください

主なガイドライン:技術的な言語でのウィキペディア:スタイルマニュアル

  • 専門用語と頭字語は慎重に使用してください。専門用語を説明し、頭字語を最初に使用するときに展開します。さらに、その後は控えめに使用するか、まったく使用しないことを検討してください。特に、一度に多くの新しい用語が導入されている場合は、より馴染みのある英語の単語に置き換えると、混乱を減らすのに役立つ可能性があります(正確さを犠牲にしない限り)。
  • 精度が失われない場合は、専門用語の代わりに一般的な用語を使用してください技術用語を、完全に同等の一般的な用語に置き換えます。
  • 説明文の前に警告を付けることを検討してください。わかりやすくするために説明が不完全または正確でない場合は、「一般的に...」や「一部の例外を除いて..」などのフレーズを前に付けて、説明の背後に複雑さが増していることを読者に知らせます。簡単な説明文に詳細を追うか、「堅牢な定義」セクションを含めて、記事全体が完全で正確になるようにします。
  • 形容詞、特に技術的な形容詞の長い文字列を削除します
  • 可能な場合は短い文を使用してください。文の長さが12語を超えると、理解度が劇的に低下します。ただし、短い文を連続して使用しすぎると単調になります。読者の興味を維持するために文の長さを変えます。
  • 読みやすさを向上させるために、より多くの動詞を使用します –多くの技術的な形容詞を動詞に置き換えることができます。
  • 会話で使用するのと同様の言語を使用してください。多くの人は、記事を書いたり、会議で話したりするときに、より専門的な言葉を使用しますが、会話では、より理解しやすい散文を使用しようとします。
  • アナロジー使用して、日常の用語で主題を説明します。遠い類推は避けてください。最良のアナロジーは、理解の欠如と完全な理解の間にすべての違いをもたらすことができます。ただし、ウィキペディアは教科書はないため、類推は百科事典的な方法で記述し、信頼できる情報源に起因する必要があります特定の情報源のない広範な説明は、独自の研究、または統合による独自の研究を構成する可能性があります。

単純化しすぎないでください

理解しやすくするために、資料を単純化しすぎないことが重要です。百科事典の記事は、読者が理解していないときに何かを理解しているという感覚への簡単な道を読者に与えるという意味で、「子供に嘘をつく」べきではありません。

技術的すぎる記事のラベル付け

合意された理解可能性の基準を満たしていない記事にラベルを付けるために、さまざまなテンプレートを利用できます。

十分に理解できない記事の場合、テンプレートは対応するディスカッションページの上部に挿入する必要があります。トークページに、技術的すぎると思う理由についてのコメントや改善のための提案を添えて説明する必要があります説明なしで追加されたテンプレートは、無視されるか削除される可能性があります。このテンプレートを含む記事は、Category:Wikipediaの技術的すぎる記事にあります{{Technical}}

このタグは、上記のガイドラインに従って誰かが改善できると思われる記事にのみ使用してください。

「はじめに...」の記事

やむを得ず技術的であると同時に、非技術的な読者にとって非常に興味深いトピックの場合、1つの解決策は別の紹介記事である可能性があります。例はウイルス入門です。現在の「Introductionto ...」記事の完全なリストは、Category:Introductory Articlesにありますが、このように補足された主要な記事のリストは、Category:Articles with個別の紹介です。

ウィキペディアのWP:NOTポリシー、WP:LEADガイドライン、およびコンテンツフォークに関するガイドラインの精神に沿って、個別の紹介記事の数を最小限に抑える必要があります。始める前に、自問してみてください

  • 前のセクションで与えられたアドバイスに従って、個別の紹介を必要とせずに、記事を全体として十分に理解できるようにすることができますか?
  • 目前のトピックに対する一般的な関心の程度を考えると、よく書かれたリードで十分でしょうか?

これらの質問に対する答えが「いいえ」の場合は、「はじめに...」の記事を開始できます。

も参照してください

外部リンク

  • 「トピック:Web向けの執筆」ニールセンノーマングループ
  • 「15」。Webコンテンツの作成 (PDF)リサーチベースのWebデザインとユーザビリティガイドライン米国保健社会福祉省。2006年8月15日。ISBN 0-16-076270-7
  • 「平易な言語行動と情報ネットワーク」米国連邦政府。
  • 「患者教育の配布物を準備するためのガイドライン」看護の専門的実践センターカリフォルニア大学デービス校