Notices


Reply
Thread Tools
Posts: 6 | Thanked: 25 times | Joined on Nov 2009 @ Helsinki
#1
Hi,

Check out the new wiki template (created by Maemo documentation team) for documenting use cases here:
http://wiki.maemo.org/Documentation/Use_case_template

The template is intended to be used as an instruction and guideline for anyone interested in documenting a Maemo-specific use case. So if you want to document a use case yourself, you can take the template as a basis, and it should guide you through the writing process.

Use cases are a bit of a tricky concept. Here, we mean tutorial-like material for developers, "How to's" with code examples that help in understanding how to make your application interact with existing Maemo platform functionalities. An example might be "How to capture an image".

I would be delighted to get any comments, critique, and/or improvement ideas concerning the use case template through this post thread. So please let me know if you find this useful!
 

The Following 6 Users Say Thank You to tittav For This Useful Post:
Posts: 263 | Thanked: 674 times | Joined on Apr 2008 @ Lyon, France
#2
Hi,

Reviving this thread - Titta is/was looking for suggestions for things which need to be documented - think of it as half way between tutorial & code sample. How to use a certain API, and why, prerequisites, set-up & tear-down. It doesn't necessarily need to be one library, it could be how to make things work together.

Any suggestions? Shout here! And add your suggestion to the & create new "use-case" pages in the wiki from the template if you'd like to http://wiki.maemo.org/Documentation_wishlist or add your templates to http://wiki.maemo.org/Documentation#Tasks_and_use-cases

Dave.

Cheers,
Dave.
 
Reply

Thread Tools

 
Forum Jump


All times are GMT. The time now is 19:19.