← Back to team overview

dhis2-devs team mailing list archive

Re: Documentation

 

2009/11/18 Lars Helge Øverland <larshelge@xxxxxxxxx>

>
>
> 2009/11/18 Knut Staring <knutst@xxxxxxxxx>
>
>> 2009/11/18 Lars Helge Øverland <larshelge@xxxxxxxxx>
>>
>>
>>> Hi there,
>>>
>>> there has recently been some nice contributions to the documentation
>>> writing, which is great.
>>>
>>>
>>> I was wondering about this:
>>>
>>> 1. Could we quickly and together come up with an overall table of
>>> contents? This will be a useful starting point, give us an overview of what
>>> we need to write and make it easier to delegate tasks.
>>>
>>
>> This is very much needed for consolidating all the material we already
>> have and highlight what is missing. A beginning has been done here:
>>
>> http://www.openhealthconsortium.org/wiki/doku.php?id=dhis_2_documentation&s[]=manual
>>
>>
>>
>
>>> 2. Should we assemble all the xml files / modules into one file? To me
>>> its more sensible to have all of it in one document.
>>>
>>
>> Agree. Though it may make some sense to keep it separate while we are
>> converting from Word, so several people can more easily work in parallel.
>> But there is a big collation/consolidation task waiting on us, related to an
>> overall structure as defined above. Another question is whether we should
>> have one strictly technical part (this button does this) and another more
>> didactic part (as the Indian manual is - with explanations of FOSS etc). It
>> may be that professional help from a technical writer would be useful for
>> such structuring.
>>
>>
>
> Yes that might be sensible.
>
>
> OK so we have a few tasks:
>
> 1. Write a draft table of contents. Suggest how we structure the document
> re what Knut says above.
>
> 2. Merge what we already have into our document. Sources are the Indian
> manual, the openhealthconsortium wiki, the help file inside
> dhis-web-commons-resources. More?
>
>
Oh yes, munch more out there:

http://208.76.222.114/confluence/display/DOC/Home
http://folk.uio.no/olati/filer/Customising_DHIS2.pdf (linked from
http://208.76.222.114/confluence/display/DOC/Home,a  BEANISH deliverable,
has some conecptual stuff on data elements, indicators, data sets etc,
design principles from paper to db)
https://answers.launchpad.net/dhis2
https://answers.launchpad.net/dhis2/+faqs*
*
http://208.76.222.114/confluence/download/attachments/8489/Comprehensive+HIS+training.zip?version=1(it's
the SL training and manual)
http://208.76.222.114/confluence/download/attachments/8489/DHIS+Short+user+manual.doc?version=1(Sierra
Leone)
http://208.76.222.114/confluence/display/DHIS1/DHIS+1.4 (some useful
conceptual explanations by Calle here (survey data, onchange periods etc.
http://208.76.222.114/confluence/download/attachment/466/DHIS+1.4+maintenance+manual+for+Zanzibar.doc?version=1(needs
a bit of a rewrite for DHIS 2, but design principles part should be
useful)
Tanzania manual for DHIS 2 (Mahundi is working on it)
Tanzania DHIS 2 data set design document, best practices for design (Lungu
is working on this)
VN user manuals for DHIS2 (needs translation)

3. Create a structure file which assembles the modules into one document.
> (Jason)
>
>
> If we get this in place we can later assign sub-tasks to people dependent
> on experience/knowledge, which will be easier to take on.
>
>
> Any volunteers?
>
>
It always work better if we can link this directly to needs or even budgeted
project tasks in countries implementing DHIS. A lot of documentation is
happening here already, but needs coordination and common tools.

I am sure Tanzania, India, Sierra Leone, and Malawi are all right now either
planning to write, are already writing new manuals, or are updating their
existing manuals.

These are the processes that should drive the manual writing and then maybe
more experienced DHIS implementers can do some quality control and editing
at some point.


> I am more than willing to contribute by documenting the inner workings of
> dhis2 but I feel there are people in the network with more experience from
> the health worker / user perspective who will do these tasks better (rather
> than a developer).
>
> Lars
>
>
> _______________________________________________
> Mailing list: https://launchpad.net/~dhis2-devs<https://launchpad.net/%7Edhis2-devs>
> Post to     : dhis2-devs@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~dhis2-devs<https://launchpad.net/%7Edhis2-devs>
> More help   : https://help.launchpad.net/ListHelp
>
>

Follow ups

References