Difference between revisions of "Wiki Contribution Guidelines"
From Apache OpenOffice Wiki
B michaelsen (Talk | contribs) (removed "management summary" from the header. Drew's right, Zen sounds friendlier than rules and two headlines should be enough for everybody) |
|||
(26 intermediate revisions by 9 users not shown) | |||
Line 1: | Line 1: | ||
− | + | This page is about the experience for both the authors and the readers of the Apache OpenOffice (AOO) Wiki. Think of the "Zen for the AOO Wiki" to make it clean, helpful and beautiful. | |
− | + | There are several sets ... starting with essential ones up to the administration guidelines. | |
− | + | ||
− | + | ||
− | + | ||
− | == | + | == Essential Guidelines<br> == |
− | + | *[[Communication|Communicate your plans!]] | |
+ | *Categorize your wiki pages | ||
+ | *Use many wiki-links between your pages | ||
+ | *Do not use redirects on category pages | ||
+ | *Keep drafts on your [[Special:MyPage|userpage]] | ||
+ | *''ALWAYS PREVIEW'' your work before you save! | ||
− | |||
− | |||
− | |||
− | |||
+ | == Standard Guidelines<br> == | ||
+ | |||
+ | {| class="prettytable" | ||
+ | |- | ||
+ | | style="width: 12em; padding-top: 0.5em; padding-bottom: 0.5em;" | '''Topic''' | ||
+ | | style="width: auto;" | '''Hints''' | ||
+ | | style="width: 20em;" | '''Examples''' <!-- if needed --> | ||
+ | |- | ||
+ | | valign="top" | '''General''' | ||
+ | | valign="top" colspan="2" | | ||
+ | * [[Communication|Communicate your plans!]] | ||
+ | *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. | ||
+ | * '''Keep an eye on your contributions.''' If they are reverted, it is probably for a reason. Find out why so you don't make the same mistake again. If they are kept, then you're doing good things! | ||
+ | *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" | | ||
+ | *When doing '''drafts''', do those on your User-page. Use it as your sandbox. 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. | ||
+ | | valign="top" | | ||
+ | * [[User:B michaelsen]] | ||
+ | :esp. the staging area | ||
|- | |- | ||
− | | valign="top" | ''' | + | | valign="top" | '''Deleting Pages''' |
− | | | + | | valign="top" colspan="2" | |
− | * | + | *To '''delete''' a page (because it is spam or outdated), add the Wiki Syntax <tt><nowiki>{{delete}}</nowiki></tt> anywhere on that page. |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|- | |- | ||
− | | valign="top" | ''' | + | | valign="top" | '''Links & URLs''' |
− | | | + | | valign="top" colspan="2" | |
− | * | + | *Wherever possible, use '''Wiki-Links''' or [[wikipedia:InterWikimedia_link|InterWiki-Links]] |
− | + | *: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" | ''' | + | | valign="top" | '''Categories and Subpages''' |
− | | | + | | valign="top" | |
− | * | + | *'''Always add new pages to an existing category''' by adding a text like '''<nowiki>[[Category:Marketing]]</nowiki>''' to the page. The all categories are listed in the [[:Category:MainIndex]] |
+ | *: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 may need to add that to an existing category too (making it a subcategory). | ||
+ | *never redirect from a category page | ||
+ | | valign="top" | | ||
+ | * [[Mercurial]] | ||
+ | * [[Build Environment Effort]] | ||
+ | * [[Writer]] | ||
+ | * [[:Category:Documentation]] | ||
+ | |- | ||
+ | | valign="top" | '''Discussion tab and Userpages''' | ||
+ | | valign="top" colspan="2" | | ||
+ | *Your bio should be on your [[Special:MyPage|userpage]]. You may redirect to it from the main-namespace. | ||
+ | *Use the '''discussion tab''' of a page to discuss pages and explain why you wrote something. | ||
+ | *'''Never redirect to the main-namespace from the talk- or the user-namespace.''' | ||
+ | |} | ||
− | + | == Advanced Guidelines == | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | 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> | |
− | + | ||
− | + | [[ru:RU/rules/wiki_contribution_guidelines]] | |
− | <noinclude>[[Category:Wiki Maintenance]][[Category:Guidelines]]</noinclude> | + |
Latest revision as of 10:20, 13 July 2018
This page is about the experience for both the authors and the readers of the Apache OpenOffice (AOO) Wiki. Think of the "Zen for the AOO Wiki" to make it clean, helpful and beautiful.
There are several sets ... starting with essential ones up to the administration guidelines.
Contents
Essential Guidelines
- Communicate your plans!
- Categorize your wiki pages
- Use many wiki-links between your pages
- Do not use redirects on category pages
- Keep drafts on your userpage
- ALWAYS PREVIEW your work before you save!
Standard Guidelines
Topic | Hints | Examples |
General |
| |
Creating Pages |
|
|
Deleting Pages |
| |
Links & URLs |
| |
Categories and Subpages |
|
|
Discussion tab and Userpages |
|
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.