Difference between revisions of "RPi Wiki Best Practice"

From eLinux.org
Jump to: navigation, search
(Get involved)
(Make it safe)
Line 25: Line 25:
  
 
=Make it safe=
 
=Make it safe=
make it clear to which audience the current page is aimed at , as seen here [[RPi Advanced Setup]]
+
Make it clear to which audience the current page is aimed at , as seen here [[RPi Advanced Setup]]
  
 
Keep the beginners in mind.
 
Keep the beginners in mind.
 +
The news of CE  marking shows that a load of boards will get into the hans 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=
 
=Think of others=
  

Revision as of 14:08, 4 April 2012


This is not your private wiki

eLinux.org is not an encyclopedia and not a wiki dedicated only towards he Raspberry Pi. Many communities and development boards are being documented here. There has been no / very little communication with the site owners and global admins about our project  !
If someone knows anything else , especially about mode of administration and ongoing/lost interest of original site owner/project founder , please communicate !

Get involved

Need help ? Look here: Help:Contents.

AND: DICUSS - Use the discussion pages !
PROTIP: 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

  • add [[Category:RaspberryPi]] to each of your articles and uploads
  • put this at the end of your page :
=References= 

Looks better ;-)

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 hans of end-users . There is no way to influence this , therefore , ADAPT.

  1. Do not expect torough knowledge of the subject.
  2. Simple language
  3. Clear intructions
  4. 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

  • {{Template:Raspberry Pi}} for the main pages
  • {{Template:RPi_Startup}} very important pages

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