← Back to team overview

dhis2-devs team mailing list archive

Re: Documentation

 

On Tue, Dec 8, 2009 at 5:26 PM, Ola Hodne Titlestad <olatitle@xxxxxxxxx> wrote:
> Hi,
>
> I also like the way the manual is shaping up.

Well, at least we have something that sort of looks like a manual now. :)


>
> There is at least one major part missing though and that is what often is
> called database maintenance or design.
> with three major subsections:
>
> 1)Orgunits, hierarchies, group sets and groups:
> What are they, how to set them up, what is the recommended usage.

Well, we can start with a simple outline and try and fill in the gaps.
>
> 2)Data elements, categories, datasets, groups and group sets:
> What are data element, dimensions, and data sets? How to go from a paper
> form to a DHIS dataset?
> best practices, examples


Yes, the manual up until now has been pretty much which button do you
press. There needs to be a complete separate set of documents on
implementations.

>
> How much from the Indian module can we use here?

I sent an email about the Indian modules a while back. I am not really
sure if we can salvage a whole lot else from them, except what I
mentioned in my mail. I have been sick in bed the past few days, and
have had no appetite for either food or DocBook, but I will take a
look this week.

>
> And there are text on this on the help page as well that can be used:
> http://dhis.uio.no/demo/dhis-web-commons-about/help.action

Agreed, but we need to figure out how and if the docbook branch and
the inline help should somehow be syncronized.
>
> I think there are some useful text in the administrators manual I wrote some
> years ago as well (http://folk.uio.no/olati/filer/Customising_DHIS2.pdf).

Looks good. Do you have the Word Doc?

>
> I can help to fill in the gaps here.
>
> And then maybe another crucial chapter missing is "data analysis and
> reporting", at least an intro to that with three core building blocks:
>
> 1) Aggregation
> how it takes place (over time, over space, avg/sum, aggregation levels,
> datamart
> This is already in docbook format and needs to go into the main document

This is simple and I can commit this soon.

>
> Should be try to come up with a more comprehensive table of contents in the
> main doc (including stuff that is not written up) to get a better overview
> of the gaps?

As mentioned above, I think an outline would be a very good starting
point, and given your experience with the development of DHIS,
implementations in the field, and work with HMN, I cannot think of a
better candidate for this. ;)

Cheers,
Jason



References