Difference between revisions of "How to contribute documentation"

From ADempiere
Jump to: navigation, search
This Wiki is read-only for reference purposes to avoid broken links.
m (typos and readability)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
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.  
+
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 and Howtos.  
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.  
+
 
 +
If you have spent a lot of time and energy solving a difficult problem, please post your notes, or summarize all the difficulties you have had, and share them with us, other people will test your solution and maybe even improve it, correct it, or find a better way to do it; and everybody will be benefit, this is the way an open community works.  
  
 
==Start small==
 
==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.
+
Don't be shy; even if your documentation is composed merely of some sketchy notes, remember that every little tip counts and will help other people. Putting it here in the open will allow people to 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 makes things much easier, this is basically what a Wiki is about. Making your documentation open is inivitation for other people for testing and improving it. This is similar to the ''release often'' mantra we see in open source software development.
+
Writing a huge chunk of documentation is overwhelming for anybody, but contributing small chunks from time to time makes things much easier; this is basically what a Wiki is about. Making your documentation open is an invitation for other people to begin testing and improving it. This is similar to the ''release often'' mantra we see in open source software development.
  
Wiki makes this process very natural straighforward
+
Wiki makes this process very natural and straightforward.
  
 
==Refactor often==
 
==Refactor often==
  
As code, documentation can also benefit from refactoring. This is the small intellectual approach as with software also the process is easier, the benefits can be big.
+
As with software code, documentation can also benefit from refactoring. Such an approach not only makes the process of writing documentation easier, but can also lead to big benefits later.
  
 
==See also==
 
==See also==

Latest revision as of 18:22, 3 January 2007

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 and Howtos.

If you have spent a lot of time and energy solving a difficult problem, please post your notes, or summarize all the difficulties you have had, and share them with us, other people will test your solution and maybe even improve it, correct it, or find a better way to do it; and everybody will be benefit, this is the way an open community works.

Start small

Don't be shy; even if your documentation is composed merely of some sketchy notes, remember that every little tip counts and will help other people. Putting it here in the open will allow people to 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 anybody, but contributing small chunks from time to time makes things much easier; this is basically what a Wiki is about. Making your documentation open is an invitation for other people to begin testing and improving it. This is similar to the release often mantra we see in open source software development.

Wiki makes this process very natural and straightforward.

Refactor often

As with software code, documentation can also benefit from refactoring. Such an approach not only makes the process of writing documentation easier, but can also lead to big benefits later.

See also