Help with documentation

Help with documentation

From PCLinuxOS Wiki

Jump to: navigation, search
First Steps
  • Register on this wiki
  • Join the google group for all group communications
Groups_bar.gif
Visit the Group


Discuss important issues
The most important issues are found on Talk:Main Page and Talk:Meta. Visit them, read through them and add your own opinions. To do that, click 'Edit this page' at the top or bottom, its also in the left menu. Or 'edit' on the right-hand side of any 'section' on the page. Add your comments. Note the 'editing' locations apply to all other Wiki pages as well.
Sign your comments with four tilde characters: ~~~~ and your signature will be automatically added. Or if using a Mozila based browser, look above the editing area and you can click the second icon from the right to add your signature and time/date.
Help with todo items
Discuss or help with the todo list. It's very helpful to hear your opinions, because it lets us know what's important to you. Note: If you fix up a todo ? Please remove the old todo as well, it has done its job and becomes redundant !
Edit and discuss pages
Just check out a page or two, edit it and contribute a little. Even a spelling correction is a big boost.
At the top of every page is a 'discussion' tab. Click it to visit that page's "talk page" and add your comments.
Sign your comments with four tilde characters: ~~~~ and your signature will be automatically added. Or if using a Mozila based browser, look above the editing area and you can click the second icon from the right to add your signature and time/date.
PCLinuxOS Magazine
Do you want to help but do not know what to do, or do not think you have the expertise knowledge ?. Then you could help by putting the content of any/some/all of the articles that have been published in PCLinuxOS Magazine in to this WiKi ! Now this will require a little more than just a copy and past, as the format of the Mag. PDF's or HTML is not exactly the same as can be done in the WiKi. So a little re-working of how things are presented will be required. But all the content is already written up already, it s just a matter of putting it in here. This PclosMag2wiki is the place for these articles.


Be a Gnome
Wiki gnomes are always around without being underfoot. They fix typos, answer questions, and are the magical element which makes a wiki work well. These are the things you can do to be the best gnome you can be:
Patrol the recent changes
Help review changes to this wiki, and contribute when you're inspired to. Help weed out any spam or trollish behavior, review changes and fix spelling or style, anything!
The recent changes list was overwhelming when we set things up, but it is a great skill to have and absolutely essential to the health of this Wiki. So get into the habit! =) Note: Still very worth the time to continue doing this.
  • It is recommended that you enable "enhanced recent changes": Visit Special:Preferences, then the "Recent changes" tab at the top, and then select "Enhanced recent changes (JavaScript)" to see this list better.
  • You can visit Special:Recentchanges once, and select several options above, like hiding your own edits, and then bookmark the page. (example URL)
Create missing pages or fix broken links
See the list of pages which are linked-to but don't exist. Either make the page or fix the offending links.
Review orphaned pages
Sometimes a document is created but it isn't linked-to at all. These pages need to find a home to make it as easy as possible for people to find them. Read the document, and give it links to other documents. Then visit those documents and give links back. Nothing fancy.. just make each page referred-to somehow.
Review old documents
Help eliminate cruft on old documents. Note that versioned documents aren't as important as the latest version or regular documents. Let the old documentation rest.