Openembedded.org talk:Help: Difference between revisions

From Openembedded.org
Jump to navigation Jump to search
(proposal moved to the Openembedded namespace)
Line 1: Line 1:
''This is a first proposal for the OE-wiki help page. Please add comments below the proposal.''
--------
<span style="color:blue">
'''This page describes principles and guidelines for using this wiki (not Openembedded itself). Understand this as a best-practice suggestion. Try to follow it. But nobody will punish you if not.''' ;-)
== Naming ==
* The names of articles should be optimized for ''readers'' over ''editors''.
* Use the original, ''official'' naming from the outer world (for example, Openmoko instead of OpenMoko) with a reasonable minimum of ambiguity.
* Do not capitalize second and subsequent words unless the title is almost always capitalized in English (for example, proper names).
* In general only create page titles that are in the singular, unless that noun is always in a plural form in English.
* Avoid the use of abbreviations, including acronyms, in page naming unless the term you are naming is almost exclusively known only by its abbreviation and is widely known and used in that form.
* Page names should not begin with non-alphanumeric characters.
* Do not use an article name that suggests a hierarchy of articles.
== Style ==
* Style and formatting should be applied consistently within articles, though not necessarily throughout the wiki as a whole.
* Titles should be short—preferably fewer than ten words.
* Section names should preferably be unique within a page.
* For acronyms and abbreviations write out both the full version and the abbreviation at first occurrence.
* The use of abbreviations should be avoided when they would be confusing to the reader. Do not invent abbreviations or acronyms.
* Use the simplest markup to display information in a useful and comprehensible way. Markup may appear differently in different browsers. Use HTML and CSS markup sparingly and only with good reason. Minimizing markup in entries allows easier editing.
== Categorization ==
* Every page should belong to at least one category. An article's category or categories should reflect the topics and classes that are directly related to the subject. In writing an article, use the most likely categories in which the reader would look for, if they are not sure of where to find the article.
</span>
-------------
== needs to be in a category ==
== needs to be in a category ==


Revision as of 13:27, 16 February 2009

needs to be in a category

I don't think every page needs to be in a category. --Laibsch 07:59, 13 February 2009 (UTC)

It's not a need but a should. And i believe it is very helpful. If we see this help not as a dogma (as stated above) i propose to keep this point. -- Sledz 11:46, 14 February 2009 (UTC)

best-practice not dogma

The text should clearly state from the beginning that this is best-practice not dogma. I'd appreciate any contribution, no matter the form, over people being scared to contribute. This wiki is still legible, I think, we don't need to be too rigid. I guess we can just let users contribute. If they want to follow our guidelines, more power to them. If not, we can correct their "mistakes" as wiki maintainers. --Laibsch 07:59, 13 February 2009 (UTC)

Yes, i agree with this best practise instead of dogma. I'll change the proposal. -- Sledz 08:56, 13 February 2009 (UTC)
Retrieved from "https://www.openembedded.org/w/index.php?title=Openembedded.org_talk:Help&oldid=1012"