Wikipedia:Please clarify

This essay contains the advice or opinions of one or more Wikipedia contributors on the Wikipedia:Writing better articles guideline. Essays may represent widespread norms or minority viewpoints. Consider these views with discretion.

Shortcuts: WP:CLARIFY WP:CONFUSE

Contents 1 Purpose 2 How to mark articles for clarification 3 How to improve articles that need clarification 4 Specific clarification 5 See also 6 References

[edit] Purpose

The purpose of this article is to describe ways to clarify text. There are tags to flag wording that is likely to be confusing to the average reader. Tags to use:

• {{clarify}} or {{what}} to mark individual phrases or sentences
• {{elucidate}} to mark individual phrases or sections which require further explanation for general (i.e., non-expert) readers
• {{confusing}} or {{unclear}} to mark sections (or entire articles, though this is undesirable)
• {{examples}} to mark individual phrases or sentences which require examples for clarification

When using these templates, be specific: mark individual phrases, sentences, and sections in preference to entire articles. Additionally, be sure to: leave specific suggestions for improvement on the article's talk-page.

[edit] How to mark articles for clarification

• To ask for clarification for a particular phrase or sentence, simply type {{clarify}} (after the phrase or sentence) to display a superscripted tag (the tag will link here):

This is a confusing sentence.^{[clarification needed]}

• To ask for further explanation of a point made in a particular phrase or sentence, simply type {{elucidate}} (after the phrase or sentence) to display a superscripted tag (the tag will link here):

This sentence contains unexplained jargon.^{[further explanation needed]}

• To ask for clarification for a particular section, simply type {{confusing|section}} at the top of the section, to generate the following tag-box:

This section may be confusing or unclear to readers. Please help clarify the section; suggestions may be found on the talk page.

Then update the article's talk page with specific aspects to be improved.

• To ask for clarification for an entire article, consider first whether it would be more productive to tag individual phrases, sentences, or sections with {{clarify}}. If you cannot identify specific parts of the article that need clarification, write what aspects of the article you believe need clarification on the article's talk page before tagging the entire article with {{confusing}}.

[edit] How to improve articles that need clarification

• Explain jargon: Define technical terms:
  • Define extra terms early (such as: Related terms include:).
  • Add a brief definition when first using new terms, like: blog (a web log of journal entries).
  • Explain regional variations and the slang of certain professions (e.g. "[[Traffic circle|Massachusetts rotary]]").

• Could it be shorter?: Some guidelines which often help:
  • Replace clauses with adverbs (to limit prepositions to about four per sentence).
  • Delete extraneous rambling words (especially weasel words and/or peacock terms).
  • Replace longer words with shorter words.
  • Split long sentences into shorter sentences (again, four prepositions per sentence).
  • Use idioms, or familiar phrases: rather than "electron flow field" use "electric current"; replace "computer program text" with "source code"; idioms seem simpler: as in "point of view" (the "of" here does not count in the limit of four prepositions).

Compare two sentences: "Notwithstanding the controversy, she, with practiced skill, proceeded to navigate MegaX Corporation through difficult financial straits" versus "Despite the controversy, she deftly navigated MegaX Corp. through difficult financial straits" (two prepositions).

• Add a diagram or photo: Complex text might be illustrated by a diagram. Wikimedia Commons also has over 2 million images, which can be searched (such as for "galaxy"). Even if the image or diagram is not exact, mention extra details in the caption-area, or use Template:Superimpose or Template:Location_map to overlay a custom label/symbol onto an image.

• Add a wikitable or list: Multi-column wikitables could clarify groups of data; however, simple lists (with colon-asterisk ":*" bullets) might be enough. See: spark plug, with a list of risks/benefits.

• Make it clear what's happening and to what: A common example is a vague pronoun reference: "Emily was friends with Francine until she changed her job" (vague: Who changed jobs? Pronoun "she" equally applies to both). Also referring back to a list but not specifying the entry.

• Use specific wording rather than vague whenever possible: For example, instead of saying, "in the old days", specify the time period you are referring to (say, the 19th century, or the 1960s).
  • Similarly, do not reference "now": the word "Recently" or "Soon" or their synonyms will become meaningless quickly. Use "As of" or a specific date.

• Make sure you're using the right word(s): In one of the great critiques of a fellow author, Mark Twain listed eighteen rules of writing romantic fiction violated by James Fenimore Cooper.^[1] Besides the criticism of Cooper's characterisation and plot, Twain also said that a writer should:
  • Say what he is proposing to say, not merely come near it. (Avoid euphemisms; we don't have to bowdlerize)
  • Use the right word, not its second cousin.
  • Eschew surplusage (see KISS principle).
  • Not omit necessary details.
  • Avoid slovenliness of form.
  • Use good grammar.
  • Employ a simple and straightforward style.

• Make use of headings: A huge block of text can be daunting, but dividing it into sections, and subsections, can organize a logical structure onto the text, separating statements into each grouped section.

• Check your intent: Wikipedia is a place to inform and to educate. It is not a technical journal. Information from technical journals might need to be reduced to short sentences (four prepositions), because some journals encourage writing multi-level sentences spanning fifteen lines, with sub-sub-clauses.

• Check your spelling: Usually misspelled words are obvious in their intent (e.g., "Qualty" is obviously "Quality"), however "Tedting" could be "Testing" or "Texting" (or "editing"). If it is not actually misspelled, or it is intended to be so, add [sic].

[edit] Specific clarification

There are some common situations where use of a more specific clarification template might make the desired clarification more clear.

A common case is an article citing a scientific measurement without indicating how the measurement was taken. For example, the following statement about solar intensity at the earth's surface without specifying the sun's elevation could be annotated with the following tags:

• The following tag links to a Wikipedia project to clear bias based on the source of the information.

"The sun's intensity is 90 watts per square meter ^[where?]."

• The following tag links to the template to clarify "Where".

"The sun's intensity is 90 watts per square meter {{where}}."

[edit] See also

• Template:Distinguish

[edit] References