dhis2-devs team mailing list archive

[Jim Grace <jimgrace@xxxxxxxxx>]

Hi Jason,

Sounds like a great idea. The user manual *is* rather large, and I agree
that it would be nice to make a manual more focused on people who are more
focused on the programming side of things.

"Programming" here is interpreted rather broadly, everything from using
curl with the API through integration with other software, app development,
and even core development. I agree that a good dividing place is to put in
the user manual everything that happens through the UI, and the other
things in the programming manual.

I also like Knut's idea of keeping some information in the user manual, so
that users know there is a next level. Perhaps this could evolve into a
"programming" chapter, or maybe a less scary name "Customizing DHIS2". This
chapter would give an overview of the programming manual content, and the
user is referred to the programming manual for more information. Then a
technical user who wants more than they can get through the UI can be
directed to the programming manual. And a non-technical user who wants more
than they can get through the UI can ask their technical staff to consult
the programming manual and advise them. ;)

Cheers,
Jim



On Thu, Aug 21, 2014 at 8:25 AM, Farai Mutero <fmutero@xxxxxxxxx> wrote:

> Hi Jason
>
> This a most welcome development which will definitely revolutionize Web
> API driven web development. One issue which I recommend you to note would
> be:
>
> There have been so many changes in the Web API from 2.14 to 2.16 from the
> perspective of building apps on top of dhis2 such that there is always the
> risk of apps breaking when the underlying dhis2 backend is upgraded. So not
> sure how easy it will be to deal with such challenges in the upcoming
> manual. Maybe some tips and tricks (relevant to the dhis2 version in use)
> will suffice.
>  Hi there. Based on some good feedback last week during the Oslo DHIS2
> Academy, I have made a first cut of a developer manual. As I see it, this
> basically involves slicing out all of the stuff really aimed more at
> developers (and in some cases implementers) and less so, users. The chapter
> on the WebAPI is being constantly expanded by the core developers, but in
> many cases, far exceeds the level of information required by most users.
> Some of the developers/implementers which I spoke with last week wanted
> more information in the developers manual. So, I think moving the really
> technical stuff to a dedicated developer manual would be a good idea, and
> allow even more detailed technical stuff to be written, without necessarily
> addressing the needs of the  users.
>
> I have , for the time being, left the sections (Technical architecture,
> Web API, Apps, and the appendix on R) in the main manual, but I think
> (depending on feedback from the community) that we can slice these out of
> the main user manual, and put them in a dedicated developer document.
>
> Thoughts?
>
> Regards,
> Jason
>
>
> _______________________________________________
> 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
>
>
> _______________________________________________
> 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
>
>