Difference between revisions of "Good stub"

From PC-BSD Wiki
Jump to: navigation, search
m (Created page with "{{guideline}} ''This is a proposal under discussion'' A good minimum stub article is very easy to write. It consists of: #A first paragraph saying what the head term...")
 
m
Line 5: Line 5:
  
 
#A first paragraph saying what the head term means. The head term should be in '''bold''' type. One sentence is quite adequate.
 
#A first paragraph saying what the head term means. The head term should be in '''bold''' type. One sentence is quite adequate.
#A second paragraph saying why the subject is important enough to warrant a Wikipedia article. Again one sentence is adequate.
+
#A second paragraph saying why the subject is important enough to warrant a PC-BSD wiki article. Again one sentence is adequate.
 
#Optionally, a third paragraph giving relevant external links as a bulleted list. This should have a heading of ''External link(s)''.  
 
#Optionally, a third paragraph giving relevant external links as a bulleted list. This should have a heading of ''External link(s)''.  
 
#A standard [[w:boilerplate text#stubs|stub warning]].
 
#A standard [[w:boilerplate text#stubs|stub warning]].
Line 11: Line 11:
 
That's all! If you can write such a stub, this is an alternative to deleting a sub-standard article, and can be useful in many different situations, for example suspected [[w:copyright violation|copyright violation]]s. In particular, if the text already appears elsewhere on the web, make that an external link.
 
That's all! If you can write such a stub, this is an alternative to deleting a sub-standard article, and can be useful in many different situations, for example suspected [[w:copyright violation|copyright violation]]s. In particular, if the text already appears elsewhere on the web, make that an external link.
  
If you can write a better stub, or even an article, that's all the better. Always remember that stubs are ''only'' useful if ''someone'' makes them into an article. See also [[Wikipedia:Perfect stub article]].
+
If you can write a better stub, or even an article, that's all the better. Always remember that stubs are ''only'' useful if ''someone'' makes them into an article. See also [[PC-BSD wiki:Perfect stub article]].
  
 
==Example==
 
==Example==

Revision as of 21:20, 7 June 2011

Template:Guideline This is a proposal under discussion

A good minimum stub article is very easy to write. It consists of:

  1. A first paragraph saying what the head term means. The head term should be in bold type. One sentence is quite adequate.
  2. A second paragraph saying why the subject is important enough to warrant a PC-BSD wiki article. Again one sentence is adequate.
  3. Optionally, a third paragraph giving relevant external links as a bulleted list. This should have a heading of External link(s).
  4. A standard stub warning.

That's all! If you can write such a stub, this is an alternative to deleting a sub-standard article, and can be useful in many different situations, for example suspected copyright violations. In particular, if the text already appears elsewhere on the web, make that an external link.

If you can write a better stub, or even an article, that's all the better. Always remember that stubs are only useful if someone makes them into an article. See also PC-BSD wiki:Perfect stub article.

Example

Suppose that a detailed page from the (fictitious and invented for this example) site www.kikmequik.com.ca has been posted with no explanation, and is a probable copyright violation. It describes the (also fictitious for this example) material Bananabalm, which is the article name. The following stub, which would take less than a minute to write, would be appropriate:

'''Bananabalm''' is an essence made from the roots of the [[piano tree]].

It has sacred significance to the [[Kikmequik]] tribe of Western Canada, and was used as money in the frontier days.

==External links==

*[www.kikmequik.com.ca\bananabalm.htm Detailed description and history]

{{stub}}

Template:Wikimedia2