SDK/Tutorial content

Here are some recommendations for content when creating a tutorial for the MeeGo SDK.

Contents 1 Steps 2 Content and Formatting 2.1 Links to content outside wiki 2.2 Formatting 2.3 Location on wiki 2.4 Screenshots 2.5 Source Code 2.5.1 Full, buildable, samples 3 Notify of Completion

Steps

Details for the SDK documentation creation process are described [here]

# Create a bug
# Create wiki content (w/source, screenshots, etc)
# Request review, update bug.
# Add link to the appropriate section of the [Developer_Guide_for_MeeGo_1.0 Developer's page]

Content and Formatting

The content of the tutorial is up to you but it should be concise and accurate. If you are not the expert, be clear to note that. For example: "Here is one way to <perform this feature>. There may be better ways." In addition, the following components are recommended if applicable:

• Environment setup
• Sample code (with good coding style)
• Screenshots

Links to content outside wiki

Generally links to offsite content is not encouraged. Advertising, spam, or other inappropriate content will be removed and the author banned from further contributions.

Formatting

Wiki standards should be used and look similar to [Developer_Guide_for_MeeGo_1.0 other tutorial pages]. Some basics:

• Capitalize first letter of all title words. Correct: My Tutorial About Foo Incorrect: My tutorial about foo
• Headings should be level 2 (== Heading ==). Sub-headings level 3 (=== Sub-headings ===).
• Code should be in gray boxes (put one space before code lines)

Location on wiki

Links to your new tutorial should be placed on the main developer page after a peer review and only when it is ready for developers to use.

Screenshots

Screenshots are encouraged if helpful.

Source Code

• take care of the license
• take care of the coding style
• request review by area component owners
• keep it simple and clear (minimal code to showcase feature)

Full, buildable, samples

Put into public git. If Qt, qmake, make, make install should be sufficient. If not Qt, autogen, make make install should be sufficient

* Code snippets

Small snippets can just be inline

Notify of Completion

* meego-sdk dev list
* area specialists/maintainers 
* update bug