Experiences with Documentation

I had never done documentation before. Maybe I did it indirectly but it was not professional. The only good work I can recall is providing steps for installation and operation of some programs such as the functionality of ODK aggregate using Google app Engine and SDK platform.

Over the last week, I have been preparing documentation on User Controls and R Syntax Class for the African Data Initiative project. User controls are user defined form controls which can be added to tool box and using them ensure consistency in form design and quality. Some of User controls that we managed to come up with are: Data Selector and Data Selector Add Remove-for loading variables from the columns whenever data is loaded, Data Receiver- this included three set of receivers namely,: Single Receivers, Multiple Receiver and Receiver which inherited the properties of either multiple receiver or Single Receiver and lastly, the Base buttons controls of the Dialogs and sub dialogs. R Syntax Class is set of code the enabled the writing of R functions in the Visual Studio easier to the front end designers.

I must say I did not do a lot for the start since I had just provided the description of the User controls and R Syntax class and the steps involved in their implementation.

As usual, I had to present this to the ADI team and received all forms of criticism which I termed it positive criticism. Some discussions were done and this was a learning process to me.

Improvement after Discussions:

We managed to come up with the tables of contents for the whole body using word designer.

A good introduction which entailed the background was implemented.

The working example of both User Controls and R syntax class were included in the documentation

We also managed to come up with further work on User controls which entailed inclusionof factor when designing data receivers

And lastly, we managed to come up with a good conclusion and agreed even to come with text file for good online documentation

Conclusion

This was a very exciting exercise and I learned on how to deliver and at the same time learn a lot from the project. I would like to carry on with this exercise in future.

 

Leave a Reply

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>