Lack of information in self-documentation of Madagascar programs is one of the most common user complaints. In her recent presentation at the Scientific Software Days, Aleksandra Pawlik from Open University described how the NumPy project has managed to dramatically improve self-documentation of its modules by enabling and encouraging users to participate in editing. We can easily attempt to do something similar.
As the first step, the following wiki pages contain the current self-documents of programs in $RSFSRC/system:
Users are encouraged to edit these documents directly to improve the current descriptions of different programs and to make them more complete and/or easier to understand. To edit wiki pages, follow the Mediawiki Guide.
It’s very easy to edit the contents of a wiki. It only takes a few clicks.
- Click the “Edit” page tab at the top of the page.
- Make changes to the text.
- Click the “Save page” button.
Simple as that!
After review by Madagascar developers, the changes will be incorporated in the source code.