← Back to team overview

dhis2-devs team mailing list archive

Re: Documentation

 

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.


> Or is there a mvn docbkx goal for aggregating all the docs?
>
>
> regards, Lars
> _______________________________________________
> Mailing list: https://launchpad.net/~dhis2-devs
> Post to     : dhis2-devs@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~dhis2-devs
> More help   : https://help.launchpad.net/ListHelp
>
>


-- 
Cheers,
Knut Staring

Follow ups

References