openSUSE:Wiki Guidelines
From openSUSE
| Wiki Guidelines: |
|---|
| Style Guidelines - Template Guidelines - Template Messages - Article Template - Portal Template - Tag Guidelines - Categorization Guidelines - Translation Guidelines |
| openSUSE Wiki Guidelines cover essentials on how to create or edit articles in the openSUSE wiki and ensure a consistent look and feel throughout. They are based on similar Wikipedia guidelines. |
| Working DRAFT |
In case we didn't cover all concerns, leave a message on the wiki mailing list or the Wiki Team Message Board.
Contents |
Purpose
Online since August 2005, the openSUSE wiki has proved to be an invaluable resource for users, contributors and developers. However, we had no Quality Assurance (QA) step in the publishing procedure for wiki articles. This made it very hard to assure a consistent quality across all articles. Several attempts were made to scan the wiki in order to clean up, sort and merge duplicate articles, raise overall quality, introduce meaningful categories, etc. However, after all attempts we were still not where we wanted to be.
As a result, the openSUSE Wiki Team is now applying a new QA process to ensure that articles meet the required standard quality, via a flag revision system which provides the opportunity to have several revisions of articles in parallel and one approved by the Wiki Team. In short, it does not limit creation of new content, but allows only quality content to be shown by default. Please refer to Wiki QA Process to get a deeper explanation about this process.
The openSUSE Wiki Guidelines provide all information which help wiki contributors to write and submit quality articles that will be easily approved by the Wiki Team.
Required quality standard
In order to be flagged as Quality article and shown by default, each submitted article should:
- Be concise, complete and easy to read
- Follow defined formatting to ensure a consistent and professional look and feel
- Properly use the standardized templates
- Be correctly tagged and categorized to allow easy maintenance
Guides
The following guides provide information and instruction on how to originate, edit, approve and maintain wiki articles. Also, they describe the writing style to follow to reach the expected article quality level.
Beginners guide
If you are a volunteer but you do not know how to use the wiki, see openSUSE Wiki Help.
Style guide
The Wiki Style Guidelines were created ensure a consistent look and feel across the wiki. Adherence to the guide is mandatory.
Other useful resources:
- Help:Tag_Formatting - Lists various tags and their uses.
- Help:Structural_Page_Elements - Shows predefined wiki layouts.
- Help:Content_Elements - Describes wiki content elements.
- Help:Wiki_Reference_card - Quick reference for Wiki editors.
Template guide
The Wiki Template Guidelines covers how to add essential recurring messages to pages in a consistent way.
Other useful resources:
- openSUSE:Template_Messages - Shows almost all the major templates across the wiki
- openSUSE:Article_Template - Shows the definite layout of articles, both old and new.
- openSUSE:Portal_Template - Shows the definite layout of portals and sub-project portals, both old and new.
Tag guide
The Wiki Tag Guidelines present article tags templates that are used in a maintenance perspective. They define action to take on a specific article.
Categorization guide
The Wiki Categorization Guidelines cover usage of categories which facilitate navigation by grouping pages according to theme or target audience.
Translation guide
The Wiki Translation Guidelines cover procedures to obtain a wikis translated into other languages.
See also
External links
| Category Policies and Guidelines | |
|---|---|
This site uses the YAML CSS framework.
About openSUSE | Disclaimers | Feedback
This page was last modified on 27 December 2009, at 13:25. This page has been accessed 1,780 times.
