User documentation published

Just wanted to make people aware of the great effort people have done with the user documentation. Special thanks for Jason for writing docs and coordinating the whole bazaar… It can now be found under documentation on the dhis2 site:

http://dhis2.org/documentation

Excellent!

This will be a great boon for the understanding of what DHIS is for. Like the source code, this will never be “completed”, but we already have critical mass. There are still “button descriptions” to be added, and I guess there is nothing yet for the patient module and community systems (am I mistaken in this?), Jason has really gotten things moving. The next stage would hopefully also involve more “strategic” considerations (such as how to choose dimensions, datasets etc, how to relate to existing paper forms, and even more overall considerations such as those covered by the HMN framework and enterprise architecture).

Maybe we should add in parenthesis that the PDF is 6.2 MB, so it could make sense for many to right-click on the link and download it rather than just open it in the browser, which will take some time on a slow connection. The HTML is of course also big with all the images, in the future we may want to investigate breaking it down by chapters, but this is not a priority.

And as Jason has said earlier, we can probably also get quite far with relatively decent machine translations - though I suppose all the images need to be remade for each language…I suppose we could do with English language screenshots as a first approximation (ideally one would have both the GUI and database languages in the same language as the manual, such work is probably best undertaken by a local team, in connection with polishing the machine translation).

Knut

···

2010/1/21 Lars Helge Øverland larshelge@gmail.com

Just wanted to make people aware of the great effort people have done with the user documentation. Special thanks for Jason for writing docs and coordinating the whole bazaar… It can now be found under documentation on the dhis2 site:

http://dhis2.org/documentation


Mailing list: https://launchpad.net/~dhis2-devs

Post to : dhis2-devs@lists.launchpad.net

Unsubscribe : https://launchpad.net/~dhis2-devs

More help : https://help.launchpad.net/ListHelp


Cheers,
Knut Staring

Yeah, the PDF is going to get only bigger and bigger, which is going
to be more and more of a problem. There are the independent chapters
from which the user manual is composed, which can be downloaded
separately.

The HTML is also getting to be too big, due to all the images. I think
the solution is to produce "chunked" HTML, which breaks up the HTML
into separate pages. I will take a look at how to do this with the
maven plugin we are using, but it is very simple if you are using
Linux and have the "xmlto" program installed. I have documented how to
produce chunked HTML in the Documentation guide.

Agree that the "strategic" guide needs to be developed soon. This will
only be useful with case studies and input from different
implementations.

I will continue to do what I can in my "spare" time, but other
contributions are of course welcome. Contact me if you need a jump
start.

Regards,
Jason

···

2010/1/21 Knut Staring <knutst@gmail.com>:

Excellent!
This will be a great boon for the understanding of what DHIS is for. Like
the source code, this will never be "completed", but we already have
critical mass. There are still "button descriptions" to be added, and
guess there is nothing yet for the patient module and community systems (am
I mistaken in this?), Jason has really gotten things moving. The next stage
would hopefully also involve more "strategic" considerations (such as how to
choose dimensions, datasets etc, how to relate to existing paper forms, and
even more overall considerations such as those covered by the HMN framework
and enterprise architecture).
Maybe we should add in parenthesis that the PDF is 6.2 MB, so it could make
sense for many to right-click on the link and download it rather than just
open it in the browser, which will take some time on a slow connection. The
HTML is of course also big with all the images, in the future we may want to
investigate breaking it down by chapters, but this is not a priority.
And as Jason has said earlier, we can probably also get quite far with
relatively decent machine translations - though I suppose all the images
need to be remade for each language...I suppose we could do with English
language screenshots as a first approximation (ideally one would have both
the GUI and database languages in the same language as the manual, such work
is probably best undertaken by a local team, in connection with polishing
the machine translation).
Knut

2010/1/21 Lars Helge Øverland <larshelge@gmail.com>

Just wanted to make people aware of the great effort people have done with
the user documentation. Special thanks for Jason for writing docs and
coordinating the whole bazaar... It can now be found under documentation on
the dhis2 site:

Resources - DHIS2

_______________________________________________
Mailing list: https://launchpad.net/~dhis2-devs
Post to : dhis2-devs@lists.launchpad.net
Unsubscribe : https://launchpad.net/~dhis2-devs
More help : https://help.launchpad.net/ListHelp

--
Cheers,
Knut Staring

_______________________________________________
Mailing list: https://launchpad.net/~dhis2-devs
Post to : dhis2-devs@lists.launchpad.net
Unsubscribe : https://launchpad.net/~dhis2-devs
More help : https://help.launchpad.net/ListHelp