Jump to content

Wikipedia:Make technical articles understandable

From Wikipedia, the free encyclopedia

"WP:TECHNICAL" redirects here. For other uses, see WP:TECHNICAL (disambiguation).
Wikipedia guidelines
Behavioral
Discussions
Content
Editing
Categorization
Style
Deletion
Project content
Other
Search

Wikipedia articles should be written for the widest possible general audience.

As a free encyclopedia, Wikipedia serves readers with a wide range in background, preparation, interests, and goals. Even for articles about the most technically demanding subjects, these readers include students and curious laypeople in addition to experts. While upholding the goals of accuracy, neutrality, and full coverage of the most important aspects of a topic, every effort should be made to also render articles accessible and pleasant to read for less-prepared readers. It is especially important to make the lead section understandable using plain language, and it is often helpful to begin with more common and accessible subtopics, then proceed to those requiring advanced knowledge or addressing niche specialties.

Articles should be written in encyclopedic style, but this differs from the spare and technically precise style found in scholarly monographs and peer-reviewed papers aimed at specialists. Articles should stay on topic without twisting the truth or telling "lies-to-children", but they should also be self-contained when possible, and should not take prerequisite knowledge for granted or gratuitously use unexplained jargon or advanced technical notation: shortcuts which save time and effort for experts can be barriers to the uninitiated.

Audience

[edit]

Wikipedia has a varied audience who can be graded in three ways:

  • On familiarity with the subject.
    • The general reader has no advanced education in the topic's field, is largely unfamiliar with the topic itself, and may even be unsure what the topic is.
    • The knowledgeable reader has an education in the topic's field but wants to learn about the topic itself.
    • The expert reader knows the topic but wants to learn more or be reminded about some fact, or is curious about Wikipedia's coverage.
  • On reading ability. Various free online tools can automatically grade the readability of text or highlight complex sentence structures, like http://www.hemingwayapp.com (automated readability index)
  • By motivation to learn about the topic.

A highly educated, knowledgeable, motivated reader may comfortably read a 5,000-word featured article to the end. Another reader may struggle through the lead and look at the pictures. A good article will grab the interest of all readers and allow them to learn as much about the subject as they are able and motivated to do. An article may disappoint because it is written well above the reading ability of the reader, because it wrongly assumes the reader is familiar with the subject or field, or because it covers the topic at too basic a level or is not comprehensive.

While a member of any of the audience groups may stumble upon an article and decide to read it (for example, by clicking on Special:Random), some subjects naturally attract a more limited audience. A topic that requires many years of specialist education or training prior to being studied or discussed is in general likely to have a more limited audience. For example, a topic in advanced mathematics, specialist law, or industrial engineering may contain material that only knowledgeable readers can appreciate or even understand. On the other hand, many subjects studied at an academically advanced level remain of interest to a wider audience. For example, the Sun is of interest to more than just astronomers, and Alzheimer's disease will interest more than just physicians.

Most Wikipedia articles can be written to be fully understandable by the general reader with average reading ability and motivation. Some articles are themselves technical in nature and some articles have technical sections or aspects. Many of these can still be written to be understandable to a wide audience. Some topics are intrinsically complex or require much prior knowledge gained through specialized education or training. It is unreasonable to expect a comprehensive article on such subjects to be understandable to all readers. The effort should still be made to make the article as understandable to as many as possible, with particular emphasis on the lead section. The article should be written in simple English that non-experts can understand properly.

Technical content assistance

[edit]
Shortcut

Wikipedia strives to be a serious reference resource, and highly technical subject matter still belongs in some Wikipedia articles. Increasing the understandability of technical content is intended to be an improvement to the article for the benefit of the less knowledgeable readers, but this should be done without reducing the value to readers with more technical background.

Making articles more understandable does not necessarily mean that detailed technical content should be removed. For instance, an encyclopedia article about a chemical compound is expected to include properties of the compound, even if some of those properties are obscure to a general reader. But often summarizing highly technical details can improve the readability of the text for general readers and experts alike. For example, a long-winded mathematical proof of some result is unlikely to be read by either a general reader or an expert, but a short summary of the proof and its most important points may convey a sense to a general reader without reducing the usefulness to an expert reader. When trying to decide what amount of technical detail is appropriate to include, it may be helpful to compare with a standard reference work in the particular technical field to which the subject of the article belongs.

Lead section

[edit]
Further information: Wikipedia:Manual of Style (lead section) § Introductory text
Shortcut

It is particularly important for the first section (the "lead" section, above the table of contents) to be understandable to a broad readership. Readers need to be able to tell what an article is about and whether they are reading the correct article, even if they don't already know the topic in detail. Those who are only looking for a summary or general definition may stop reading at the end of the lead. An understandable lead encourages readers to continue reading into the body of the article.

For these reasons, the lead should provide an understandable overview of the article. While the lead is intended to mention all key aspects of the topic in some way, accessibility can be improved by only summarizing the topic in the lead and placing the technical details in the body of the article. The lead of the article should tell a general reader the field of study of the topic, the place the topic holds in its field of study, what (if anything) the topic is good for, and what needs to be learned first in order to understand the article.

In general, the lead should not assume that the reader is well acquainted with the subject of the article. Terminology in the lead section should be understandable on sight to general readers whenever this can be done in a way that still adequately summarizes the article, and should not depend on a link to another article. Any link to another article should be a supplement to provide more information, and preferably should not be required for understanding text in the lead. For highly specialized topics where it is difficult to give an overview in terms with which a general audience will be familiar, it may be reasonable to assume some background knowledge in the lead while linking to the prerequisites required to understand it. For reference, the lead for a typical Featured Article includes about 20 links to other articles (with a mean lead length around 300 words).

Rules of thumb

[edit]

Here are some more ideas for dealing with moderately or highly technical subjects:

Put the easier parts of the article up front

[edit]
Shortcut

It's perfectly fine for later sections to be more technical, if necessary. Those who are not interested in details will simply stop reading at some point, which is why the material they are interested in needs to come first. Linked sections of the article should ideally start out at a similar technical level so that if the first, easier paragraph of an article links to a section in the middle of the article, the first part of the section linked to it should also be understandable. Further, even more-technical sections can often be improved upon by summarizing the main ideas in the first paragraph before going into details.

Avoid circular explanations: don't define A in terms of B, and B in terms of A. Check to make sure that technical terms are not used before they are defined.

Write one level down

[edit]
Shortcut

A general technique for increasing accessibility is to consider the typical level where the topic is studied (for example, secondary, undergraduate, or postgraduate) and write the article for readers who are at the previous level. Thus articles on undergraduate topics can be aimed at a reader with a secondary school background, and articles on postgraduate topics can be aimed at readers with some undergraduate background. The lead section should be particularly understandable, but the advice to write one level down can be applied to the entire article, increasing the overall accessibility. Writing one level down also supports our goal to provide a tertiary source on the topic, which readers can use before they begin to read other sources about it.

Add a concrete example

[edit]

Many technical articles are not understandable (and more confusing even to expert readers) only because they are abstract. A concrete example can help many readers to put the abstract content in context. Sometimes a contrasting example (counterexample) can also be helpful. For instance, from the article verb:

A verb, from the Latin verbum meaning 'word', is a word (part of speech) that in syntax conveys an action (bring, read, walk, run, learn), an occurrence (happen, become), or a state of being (be, exist, stand).

Examples must still meet the same requirement of no original research that other content is subject to.

Explain formulae in English

[edit]

When possible, even for experts it can be helpful to explain in English why the formula has certain features or is written a certain way. Explaining the "meaning" of a formula helps readers follow along. At a minimum, make sure all the variables in a formula are defined in the article, or have links to articles that explain them.

Add a picture

[edit]
Further information: Wikipedia:Graphs

Visual depictions enable many people to learn more effectively, and allow technical concepts to be communicated in a more concise and clear manner. Diagrams should be related to symbolic or verbal descriptions where appropriate. Some templates that might be useful:

Avoid overly technical language

[edit]

Main guideline: Technical language in Wikipedia:Manual of Style

  • Use jargon and acronyms judiciously. Explain technical terms and expand acronyms when they are first used. In addition, you might consider using them sparingly thereafter, or not at all. Especially if there are many new terms being introduced all at once, substituting a more familiar English word might help reduce confusion (as long as accuracy is not sacrificed).
  • If no precision is lost, use common terms instead of technical terms. Substitute technical terms with common terms where they are completely equivalent.
  • Consider prefacing explanatory sentences with caveats. When a less complete or precise explanation is given to improve clarity, preface it with a phrase such as "Generally..." or "With some exceptions..." so the reader knows that there is more complexity behind the explanation. Follow the brief explanatory sentence(s) with more detail, or include a "robust definition" section so that the article as a whole is complete and precise.
  • Eliminate long strings of adjectives, particularly technical adjectives.
  • Use some short sentences and short paragraphs. Comprehension decreases when sentence length exceeds about 12 words. However, using too many short sentences in a row becomes monotonous and stilted; vary sentence length to maintain reader interest. Similarly, split long paragraphs into smaller ones.
  • Use more verbs to improve readability. You can replace many technical adjectives with verbs. For example, instead of saying "Method X is the best one" say, instead: "Method X improves results".
  • Use language similar to what you would use in a conversation. Many people use more technical language when writing articles and speaking at conferences, but try to use more understandable prose in conversation.
  • Use analogies to describe a subject in everyday terms. Avoid far-out analogies. The best analogies can make all the difference between incomprehension and full understanding. However, Wikipedia is not a textbook, so analogies need to be written in an encyclopedic way and be attributable to reliable sources. Extensive explanations without a specific source may constitute original research, or original research by synthesis.

Don't oversimplify

[edit]
Shortcut

It is important not to oversimplify material in the effort to make it more understandable. Encyclopedia articles should not "tell lies to children" in the sense of giving readers an easy path to the feeling that they understand something when they don't.

Labeling articles that are too technical

[edit]

Various templates are available for labeling articles that do not meet agreed standards of understandability.

For articles that are not sufficiently understandable, the {{Technical}} template should be inserted at the top of the corresponding discussion page. You should put an explanation on the talk page with comments on why you believe it is too technical, or suggestions for improvement. Templates added without explanation are likely to be either ignored or removed. Articles containing this template can be found in Category:Wikipedia articles that are too technical.

This tag should be used only on articles which you feel could be improved by someone following the guidelines listed above.

"Introduction to..." articles

[edit]

For topics which are unavoidably technical but, at the same time, of significant interest to non-technical readers, one solution may be a separate introductory article. An example is Introduction to viruses. A complete list of current "Introduction to..." articles can be found in Category:Introductory articles, while a list of main articles thus supplemented is Category:Articles with separate introductions.

In keeping with the spirit of Wikipedia's WP:NOT policy, WP:LEAD guideline, and guideline on content forking, the number of separate introductory articles should be kept to a minimum. Before you start one, ask yourself

  • Following the advice given in the preceding sections, can the article be made sufficiently understandable as a whole, without the need for a separate introduction?
  • Given the degree of general interest in the topic at hand, might a well-written lead be sufficient?

You may start an "Introduction to..." article if the answer to these questions is "no".

See also

[edit]
[edit]
  • "Topic: Writing for the Web". Nielsen Norman Group.
  • "15–Writing Web Content". Research-Based Web Design & Usability Guidelines (PDF). U.S. Department of Health & Human Services. August 15, 2006. ISBN 0-16-076270-7.
  • "Plain Language Action and Information Network". U.S. Federal Government.
  • "Guidelines for preparing patient education handouts". Center for Professional Practice of Nursing. UC Davis. Archived from the original on 2013-12-07.
Retrieved from "https://en.wikipedia.org/w/index.php?title=Wikipedia:Make_technical_articles_understandable&oldid=1246773486"