search

taarifa / Taarifa_Web

THIS CODE BASE IS DEPRECATED AND ONLY HERE FOR ARCHIVAL PURPOSES!
http://www.taarifa.org
Other
18 stars 6 forks source link

Documentation #8

Open markiliffe opened 12 years ago

markiliffe commented 12 years ago

We need to document how to use the Taarifa platform. In this it is not just the documentation of code but also user documentation showing how all users (end, administrators and coders) can do the things they need to do. I personally feel we need to steer clear of monolithic massive documents detailing every feature (because of inheriting Ushahdi's code base we have a lot of features in built) but screencasts and other simple quick snippets.

markiliffe commented 12 years ago

Assigned to @puntofisso, due to his work on the wiki. Keep up the push!

puntofisso commented 12 years ago

I will have a look, but want to get through the "basic" manuals first. As you suggest, I would stay away from monolithic docs. I would keep stuff as small, one-action "how-tos", so we can switch easily between functionalities if we switch away from Ushahidi.

markiliffe commented 12 years ago

Agreed, this is one of the things @jkosem is looking at with front end. I'm currently unsure how much @cazcazn will be doing on the design. One of the things I like about the Ushahidi design is that it 'works'. Considering the complex nature of data collection and the environments which Taarifa is deployed in, this is important.

Secondly while bite sized manuals and how-to docs are very useful, however a large 'authoritative' manual is needed in areas with low connectivity. This can also have the effect of assurance.