Welcome to the documentation team

UserPreferences

This wiki is in 'slumber' mode, just like its associated sourceforge project. Edits are disabled, the content is potentially stale and is not maintained. That said, it contains some really useful stuff still. Enjoy!

Want documentation? Help write it!

You are using an open source project. Open source projects chronically lack free quality documentation (though there will often be a good book at O'Reilly). This is universally frustrating for users. Bad luck! Open source projects are run by volunteers, and if there is no volunteer to write the documentation there won't be any.

To solve this, Jicarilla is "Docware": you are placed under the moral obligation to help write end user documentation. If you ask a question and recieve an answer, document question and answer on the JicarillaWiki. If you ask for a code change and someone implements it for you or submits the patch, document the new or changed behaviour and provide usage instructions. If you submit a patch, make sure you include full and sensible javadocs with the patch.

If you are a programmer yourself, consider Jicarilla "testware" as well. Everytime you submit a patch, submit a unit test with it that tests the correct behaviour of the code to which your patch applies. If there are no tests for that particular code yet at all, write them.

The contents of this wiki are licensed under a Creative Commons License.