Difference between revisions of "Good stub"

From PC-BSD Wiki
Jump to: navigation, search
m
m
Line 15: Line 15:
 
==Example==
 
==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:   
+
Suppose that a detailed page from the (fictitious and fabricated for this example) site www.ever-microsquish-vacs.com.py 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:   
  
 
<nowiki>
 
<nowiki>

Revision as of 20:35, 7 June 2011

Template:Guideline This is a description of a PC-BSD wiki standard.

A good initial page stub 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 document on a PC-BSD wiki page. Again one sentence is adequate.
  3. Optionally, a third paragraph giving relevant applicable 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 removing a sub-standard page, and can be very useful in the process of creating or revising the PC-BSD Handbook. Also, it is a way to handle suspected copyright violations. In particular, if the text exists on the web already, make that an external link which also helps to feed back into the community by increasing interconnectedness.

If you can write a better stub, or even a handbook page, 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 page stub.

Example

Suppose that a detailed page from the (fictitious and fabricated for this example) site www.ever-microsquish-vacs.com.py 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

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox