Show Media Item - Planets Nu Documentation - Volunteers Needed!Planets Nu Documentation - Volunteers Needed!
Wednesday, December 31, 2014
The How to Play section on Planets Nu is now getting an upgrade. In order to maintain relevant and up to date documentation for the game that can continue to grow and expand we have created a simple tool to allow interested community members to edit the documentation section.
Long Term Accessibility and Search
In order to help create a great documentation section we would like to ask for volunteers to help edit, add to and maintain the help section.
The new documentation can be found here: http://planets.nu/#/howtoplay/intro
If you are a designated "Editor" you will have an edit button on each page that will take you to the documentation editing section to edit that page. Or you can go to the documentation editor here:
If would like to become an editor and be able to help with the editing of the how to play section please use the Contact link at the bottom of the page to let us know and we'll upgrade your security level.
Those helping with the Translation project already have edit access to the docs. The new documentation section has already been linked to the language files, however we will not begin the translation of the doc pages themselves until they are reasonably stable.
Planning the Documentation
Planets has endless amounts of information that can be put into the docs. As we work toward a complete and effective documentation system it is important to keep the reader in mind. There are two primary types of readers that must be considered:
1) beginners
2) experienced players
It will be very valuable to start building a donovan's level repository of information. However, in order to accommodate both types of players it's important that we keep a very clean and simple high-level set of docs that explains the basics of how to play the game and major features as the primary documentation. We can then add "view detailed info" sections where appropriate to show formulas and calculations.
Long Term Accessibility and Search
Great documentation is only as great if you can find it when you need it. The new system is designed to make the information much more accessible. The following will come online during the editing process:
1) In addition to the how to play section, documentation will be also accessible through the in-game assistants.
2) Context Sensitive help will allow immediate access to documentation when clicking on areas of the UI.
3) The new documentation will be accessible via the API and hopefully can become a long term easily accessible and reproducible source of information which can be published on any platform.
4) The documentation will be published in a mobile friendly "static" web page form where it can be crawled effectively by search engines and a Google search box will be added.
We believe this will lay the foundation for a long term, effective repository of the rules and instructions for playing Planets.
Note on copyright: Please do not copy and paste content from other sites into the Planets Nu repository without first getting permission. Formula's can be entered as you believe them to be and will be reviewed by the Nu team.
UPDATE: Static version can be found here: http://help.planets.nu