RPi Wiki Best Practice

From eLinux.org
Jump to: navigation, search

Note: This page is nominated for deletion. The nominee is Jeff. Reason: clearly misleading from Wikipedia's policies. Who uses lvl 1 headers?


This is not your private wiki

Respect the rules and prepare for a possible wiki migration !

Get involved

Need help ? Look here: Help:Contents.

AND: DICUSS - Use the discussion pages !
TIP: If you leave a message on the page, use this signature : ~~~~ . After saving , it will look like this : Ghans 16:47, 18 March 2012 (UTC)

Keep basic structure

Please reapply the category RaspberryPi to existing articles !

  • prefix article name with RPi (RPi_Name)
  • add [[Category:RaspberryPi]] to each of your articles and uploads
  • put this at the end of your page :

== References == {{Template:Raspberry Pi}} [[Category:RaspberryPi]]

Make it safe

Make it clear to which audience the current page is aimed at , as seen here RPi Advanced Setup

Keep the beginners in mind. The news of CE marking shows that a load of boards will get into the hands of end-users . There is no way to influence this , therefore , ADAPT.

  • Do not expect torough knowledge of the subject.
  • Simple language
  • Clear intructions
  • Clean and understandable structure - much room for improvement there.

Think of others

Goes hand in hand with Tip # 3. DO NOT BREAK LINKS. See Help:Moving_a_page and Help:Deleting_a_page. When the wiki gets more and more imortant over the time , we should avoid breaking old (and older) links. If you are unsure wheter your goal cannot achieved otherwise (logical link loop) , discuss with others first.

Use templates

Use the templates - this is not a recommendation !

RPi_List_of_Templates

Do not arbitarily extend and change them. They are specificially made for a better (BASIC) overview. Use Categories instead (Tip #2).

Keep it modular

If you see big lists and code listing cropping up , create a new article for them .

Bad Example : RPi Buying Guide had all the information now moved to RPi Buying Links By Country within a single page.

Please use the preview and see what monster you have created.

References