Difference between revisions of "Wiki Contribution Guidelines"

From Apache OpenOffice Wiki
Jump to: navigation, search
m (moved OOo Wiki Contribution Rules to Wiki Contribution Guidelines: According to discussion on ux-discuss)
(Restructured page)
Line 1: Line 1:
−
== The Zen of OOo Wiki (Core Rules) ==
+
This page is about the experience for for both the authors and the readers of the OpenOffice.org Wiki. Think of the "Zen for the OpenOffice.org Wiki" to make it clean, helpful and beautiful.
  
−
* '''Use categories'''
+
There are several sets ... starting with essential ones up to the administration guidelines.
−
* '''use many wiki-links between your pages'''
+
−
* '''never redirect to the main-namespace from out of it'''
+
−
* '''keep drafts on your userpage'''
+
  
−
== Standard Wiki Ruleset ==
+
== Essential Guidelines<br>  ==
  
−
{| class="prettytable"
+
*Categorize your wiki pages
 +
*Use many wiki-links between your pages
 +
*Avoid redirecting to the main-namespace from out of it
 +
*Keep drafts on your [[Special:MyPage|userpage]]
  
−
|- bgcolor=#ddd
+
== Standard Guidelines<br> ==
−
| style="width:12em; padding-top: 0.5em; padding-bottom:0.5em" | '''Topic'''
+
−
| style="width:50%"  | '''Hints'''
+
−
| style="width:auto" | '''Examples''' <!-- if needed -->
+
  
 +
{| class="prettytable"
 +
|-
 +
| style="width: 12em; padding-top: 0.5em; padding-bottom: 0.5em;" | '''Topic'''
 +
| style="width: 50%;" | '''Hints'''
 +
| style="width: auto;" | '''Examples''' <!-- if needed -->
 
|-
 
|-
−
| valign="top" | '''General'''
+
| valign="top" | '''General'''  
−
| colspan=2 valign="top" |
+
| valign="top" colspan="2" |  
−
* Be constructive! Think of the problem - and think of its solution!
+
*Be constructive! Think of the problem - and think of its solution!  
−
* Think of the reader, too!
+
*Think of the reader, too!  
−
* Don't hesitate! Better write down something quickly than thinking too much and forgetting to write it down. Put drafts into your userspace (see below).
+
*Don't hesitate! Better write down something quickly than thinking too much and forgetting to write it down. Put drafts into your userspace (see below).  
−
* Be open to (early or late) changes to your contribution; don't blame others, think of the best solution to the problem.
+
*Be open to (early or late) changes to your contribution; don't blame others, think of the best solution to the problem.  
−
* If nobody contributes, maybe it's good; if myriads of people change your contribution, it might be better.
+
*If nobody contributes, maybe it's good; if myriads of people change your contribution, it might be better.  
−
* The real measure of a page is the number of page accesses shown at the bottom. To get a higher number of accesses add relevant links to your content and add categories!
+
*The real measure of a page is the number of page accesses shown at the bottom. To get a higher number of accesses add relevant links to your content and add categories!
  
 
|-
 
|-
−
| valign="top" | '''Creating Pages'''
+
| valign="top" | '''Creating Pages'''  
−
| colspan=2 valign="top" |
+
| valign="top" colspan="2" |  
−
* When doing '''drafts''', do those on your User-page. Use it as your sandbox. See for example [[User:B_michaelsen]], esp. the staging area. You are not required to add tight categories and context links on your userpage.
+
*When doing '''drafts''', do those on your User-page. Use it as your sandbox. See for example [[User:B michaelsen]], esp. the staging area. You are not required to add tight categories and context links on your userpage.  
−
* Think hard about the '''title''' of the page, its very important for search. Avoid Typos in the title!
+
*Think hard about the '''title''' of the page, its very important for search. Avoid Typos in the title!  
−
* You should make the content easy to find.  
+
*You should make the content easy to find.  
−
* Embed your contribution into existing content.
+
*Embed your contribution into existing content.  
−
*: Link to your page from as many related pages as possible to provide the needed context and to prevent duplication.
+
*:Link to your page from as many related pages as possible to provide the needed context and to prevent duplication.
  
 
|-
 
|-
−
| valign="top" | '''Deleting Pages'''
+
| valign="top" | '''Deleting Pages'''  
−
| colspan=2 valign="top" |
+
| valign="top" colspan="2" |  
−
* To '''delete''' a page (because it is spam or outdated), replace its content with <code><nowiki>{{delete}}</nowiki></code>
+
*To '''delete''' a page (because it is spam or outdated), replace its content with <code><nowiki>{{delete}}</nowiki></code>
  
−
|-  
+
|-
−
| valign="top" | '''Links & URLs'''
+
| valign="top" | '''Links &amp; URLs'''  
−
| colspan=2 valign="top" |
+
| valign="top" colspan="2" |  
−
* Always use Wiki-Links or [[Wikipedia:Interwikimedia_link|InterWiki-Links]] when possible
+
*Always use Wiki-Links or [[wikipedia:Interwikimedia%20link|InterWiki-Links]] when possible  
−
*: Don't use HTTP links, when Wiki-Links or InterWiki-Links are possible. HTTP links do not show up in "What links here" list for example, making pages [[Special:LonelyPages|orphans]] easily. InterWiki-Links are easy to update, if a Wiki changes its base-URL.
+
*:Don't use HTTP links, when Wiki-Links or InterWiki-Links are possible. HTTP links do not show up in "What links here" list for example, making pages [[Special:LonelyPages|orphans]] easily. InterWiki-Links are easy to update, if a Wiki changes its base-URL.
  
 
|-
 
|-
 
| valign="top" | '''Categories'''  
 
| valign="top" | '''Categories'''  
−
| colspan=2 valign="top" |
+
| valign="top" colspan="2" |  
−
* Always add new pages a existing category
+
*Always add new pages a existing category  
−
*: This is very important to keep the wiki maintainable. Non-English content should always be sorted in the category of the language (or one of its subcategories). If you want to create a new category, you will need to add that to an existing category too (making it a subcategory).
+
*:This is very important to keep the wiki maintainable. Non-English content should always be sorted in the category of the language (or one of its subcategories). If you want to create a new category, you will need to add that to an existing category too (making it a subcategory).
  
 
|-
 
|-
−
| valign="top" | '''Namespaces'''
+
| valign="top" | '''Namespaces'''  
−
| colspan=2 valign="top" |
+
| valign="top" colspan="2" |  
−
* Use the available namespaces:
+
*Use the available namespaces:  
−
* Your bio should be on your [[User:YourLogin|userpage]]. You may redirect to it from the main-namespace.  
+
*Your bio should be on your [[User:YourLogin|userpage]]. You may redirect to it from the main-namespace.  
−
* Categories should be described in the [[:Category:MainIndex|Category-namespace]]. You may redirect to those from the main-namespace.  
+
*Categories should be described in the [[:Category:MainIndex|Category-namespace]]. You may redirect to those from the main-namespace.  
−
* Use the Talk:-namespace to discuss pages and explain why you wrote something.  
+
*Use the Talk:-namespace to discuss pages and explain why you wrote something.  
−
* '''Never redirect to the main-namespace from the category- or the user-namespace.'''
+
*'''Never redirect to the main-namespace from the category- or the user-namespace.'''
  
 
|-
 
|-
−
| valign="top" | '''Advanced'''
+
| valign="top" | '''Advanced'''  
−
| colspan=2 valign="top" |
+
| valign="top" colspan="2" |  
−
* Use [[:Category:Wiki_Templates|Wiki templates]]!
+
*Use [[:Category:Wiki Templates|Wiki templates]]!  
−
* [[Wikipedia:Wikipedia:Transclusion|Transclusion]] is great. Use it!
+
*[[wikipedia:Wikipedia:Transclusion|Transclusion]] is great. Use it!  
−
* If your page shows up in the [[Special:SpecialPages|Maintenance reports]], you likely did something wrong
+
*If your page shows up in the [[Special:SpecialPages|Maintenance reports]], you likely did something wrong  
−
* Redirects ...
+
*Redirects ...
  
 
|}
 
|}
−
{{Documentation/Note|[[Help:Translating|Translations have some additional rules.]]}}
+
 
−
{{Documentation/Note|Even more detailed wiki rules can be found here: [[OOo Wiki Administration Rules]]. However, in general you should be fine with the basic set of rules found here.}}
+
== Advanced Guidelines  ==
−
<noinclude>[[Category:Wiki Maintenance]][[Category:Guidelines]]</noinclude>
+
 
 +
You are a wiki administrator? Then you might be interested in the [[Wiki Administration Guidelines]].
 +
 
 +
== Topic Related Guidelines  ==
 +
 
 +
[[Help:Translating|Translations have some additional rules.]]  
 +
 
 +
<br> <noinclude>[[Category:Wiki Maintenance]][[Category:Guidelines]]</noinclude>

Revision as of 21:57, 22 March 2010

This page is about the experience for for both the authors and the readers of the OpenOffice.org Wiki. Think of the "Zen for the OpenOffice.org Wiki" to make it clean, helpful and beautiful.

There are several sets ... starting with essential ones up to the administration guidelines.

Essential Guidelines

  • Categorize your wiki pages
  • Use many wiki-links between your pages
  • Avoid redirecting to the main-namespace from out of it
  • Keep drafts on your userpage

Standard Guidelines

Topic Hints Examples
General
  • Be constructive! Think of the problem - and think of its solution!
  • Think of the reader, too!
  • Don't hesitate! Better write down something quickly than thinking too much and forgetting to write it down. Put drafts into your userspace (see below).
  • Be open to (early or late) changes to your contribution; don't blame others, think of the best solution to the problem.
  • If nobody contributes, maybe it's good; if myriads of people change your contribution, it might be better.
  • The real measure of a page is the number of page accesses shown at the bottom. To get a higher number of accesses add relevant links to your content and add categories!
Creating Pages
  • When doing drafts, do those on your User-page. Use it as your sandbox. See for example User:B michaelsen, esp. the staging area. You are not required to add tight categories and context links on your userpage.
  • Think hard about the title of the page, its very important for search. Avoid Typos in the title!
  • You should make the content easy to find.
  • Embed your contribution into existing content.
    Link to your page from as many related pages as possible to provide the needed context and to prevent duplication.
Deleting Pages
  • To delete a page (because it is spam or outdated), replace its content with {{delete}}
Links & URLs
  • Always use Wiki-Links or InterWiki-Links when possible
    Don't use HTTP links, when Wiki-Links or InterWiki-Links are possible. HTTP links do not show up in "What links here" list for example, making pages orphans easily. InterWiki-Links are easy to update, if a Wiki changes its base-URL.
Categories
  • Always add new pages a existing category
    This is very important to keep the wiki maintainable. Non-English content should always be sorted in the category of the language (or one of its subcategories). If you want to create a new category, you will need to add that to an existing category too (making it a subcategory).
Namespaces
  • Use the available namespaces:
  • Your bio should be on your userpage. You may redirect to it from the main-namespace.
  • Categories should be described in the Category-namespace. You may redirect to those from the main-namespace.
  • Use the Talk:-namespace to discuss pages and explain why you wrote something.
  • Never redirect to the main-namespace from the category- or the user-namespace.
Advanced

Advanced Guidelines

You are a wiki administrator? Then you might be interested in the Wiki Administration Guidelines.

Topic Related Guidelines

Translations have some additional rules.


Retrieved from "https://wiki.openoffice.org/w/index.php?title=Wiki_Contribution_Guidelines&oldid=159883"
Personal tools