[MeeGo-SDK] SDK documentation system - Expanding the scope.

[ronan.maclaverty at nokia.com]

Hello all,

In the spirit of Bjarne Stroustrup: "Design and programming are human activities; forget that and all is lost."

Should we take all the concerns of the developer form a work group?  Something along the lines of the UX work group only for application developers.

We have several issues that we already can identify:
1. Documentation
    - Format and content
2. Tool sets
    - Qt Creator is the one currently available on the meego.com site.
      - Desired features and usability of the actual tools, APIs.
3. Processes contribution to tools and documentation.

(There is a considerably interaction between the two, good easy to use tools require different documentation, at least at the start).

Ronan.

>-----Original Message-----
>From: meego-sdk-bounces at meego.com [mailto:meego-sdk-bounces at meego.com]
>On Behalf Of ext Adrian Yanes
>Sent: 05 March, 2010 14:00
>To: meego-sdk at meego.com
>Subject: [MeeGo-SDK] SDK documentation system
>
>Hi there,
>
>For a long period of time, maemo.org has been used "Wiki" format to
>recollect the documentation related with Maemo OS.
>
>In my opinion, one of the most common failure in documentation and
>open source projects is that we use a doc systems easy to maintain for
>developers and easy to check for users, but sometimes we loose the
>"control" of them. When the project is very big , always a lot of
>people start asking about "a book" or "official manual", and this
>involves more consistent information ( the wikis can be tedious when
>we are talking about a lot of doc).
>
>It would very nice to prevent this kind of "error" and start to think
>now in what type of doc system we have to use. To document the SDK.
>
>Something like docbook (http://docbook.org/) would be a nice choice.
>
>I am not talking about rule out the wiki ( of course not ). However,
>more people would be looking for a big, complete and consistent (and
>also with a nice printed output) documentation about MeeGoo SDK in the
>next months and using this doc systems we will save time ( and also we
>will reach the possibility to create books & e-books very easy).
>
>What do you think?
>
>Regards,
>
>Adrian Yanes.
>_______________________________________________
>MeeGo-sdk mailing list
>MeeGo-sdk at meego.com
>http://lists.meego.com/listinfo/meego-sdk