How to contribute documentation

From ADempiere
Revision as of 15:42, 18 November 2006 by Sempre (Talk) (Refactor often)

Jump to: navigation, search
This Wiki is read-only for reference purposes to avoid broken links.

Documentation especially developer documentation, is one of the main weakness of Compiere. Our hope is that one of the main advantages of ADempiere will be extensive documentation, tips, tutorials, Howto. If you have spent a lot of energy solving a difficult problem, please summarize all the difficulties you have had, and share it with us, other please will test your solution and maybe even improve it, correct it, or find a better way to do it; and everybody will be benefit.

Start small

Don't be shy; even if your documentation is composed of merely some sketchy notes, every little tip count and will help other people. Putting it here in the open will make people test it and improve it. We need to start a virtuous process as good documentation will bring more people and this will benefit everyone.

Writing a huge chunk of documentation is overwhelming for evereybody, but contributing small chunks from time to time majes things mucg easier, and your contributions can be improved by other people. This is similar to the release often mantra we see in open source software development.

Wiki makes this process very natural straighforward

Refactor often

As code, documentation can also benefit from being refactored. This is the small intellectual approach as with software also the process is easier, the benefit can be big.

See also