Background
The Mifos User Manual is a core piece of documentation to assist users in properly configuring and using the Mifos software on a day to day basis. Functionality in Mifos 2.3 (Margaret H), shipping in June 2012 needs to be reflected in the user manual which is currently only up to date with our Mifos 2.3 release. Significant new functionality including value-based permissions, embedded reporting, GLIM enhancements, improved mobile money integration, integrated accounting, account transfers, and new interest calculation methodologies are being added. We're seeking volunteers with strong documentation/tech writing skills to update the User Manual to provide coverage of latest functionality. Our user manual is now easily maintained and updated in a convenient online tool, FLOSS Manuals.
Status - Seeking Volunteers
Contact
Please email documentation@openmf.org if you are interested in helping on this project.
Mentor
Ed Cable and Bharathi Ram
Current Volunteer(s)
We want this to be you!
Time Estimate
1-3 hours per specific functionality
Prerequisite experience
- Previous experience writing user or technical documentation
- Experience writing documentation for business applications/software.
- Knowledge of microfinance or financial services is helpful.
Details
The Mifos User Manual needs new sections written and current sections adjusted to properly document how to use and each of the new features. .
Documentation will be drafted based on the functional specifications which provide a detailed overview of various use cases of how the feature is used. Volunteer will write the following, based on the functional specifications:
- Short overview of each feature
- Update or expand current section in user manual with step by step instructions.
User documentation will be written according to our style guidelines in FLOSS Manuals and will include relevant product screenshots.
| Jira Issues | ||||
|---|---|---|---|---|
|
Steps
General
- Sign up for a free account on FLOSS manuals
- Visit the Mifos Demo Server (User ID: mifos | Password: testmifos) to understand how these features work and to take screenshots.
- Read up on the writing conventions for guidelines on formatting/style
- Draft documentation and edit the page in FLOSS Manuals editing interface on Booki (inserting screenshots):
- See also:
Each of the tasks above has the specific processes that must be documented for each new feature.