dhis2-devs team mailing list archive

[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?

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?

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