You are on page 1of 13

B u ild in g a C o m m u n ity th ro u g h

D o cu m e n ta tio n
Promoting your package effectively

How?
Where?
Who?
D o cu m e n ta tio n fo r a p a cka g e
qReference library
q

qEngineering documentation
q

qWiki documentation
qPackage summary
qBacklog
qNews
qContact information (wiki user pages)
qTechnical articles
q

q“Social networking”
qForum posts
qBlog posts Do you have
a wiki user
qMailing lists page?
q
q
q
q
q
R e fe re n ce lib ra ry
qReference library documentation is published on developer.symbian.org
qThis provides API reference for your package (from doxygen comments).
qThere is also some guide material.
qTake a look at
http://developer.symbian.org/main/documentation/reference/s^3
q
qThe current version is the “first attempt” and is missing some packages.
qA new version will be published in week 02.
qWe will then ask you to check that the reference contains your package
q…and that it’s accurate.
q
q
q How do you
q
use the
reference
q library?
q
q
E n g in e e rin g d o cu m e n ta tio n
qCheck the swdocwiki. Is it safe to publish what's there?
qHas it been TPIP filtered?
qCheck http://tiny.symbian.org/AgileBrowserStats
qWhat other material do you have that you could add to swdocwiki?
qPetri Kangas is the person to talk to if you have architecture
documentation you want to promote to package users.
qThere's an existing toolset and process to help you publish it.
qDo you have legacy docs that you don't intend to update? If they could
still be useful, consider putting them on Mercurial.
qTPIP filter first!
q Use swdocwiki
q for your
architecture
q
docs

qFind out more
http://developer.symbian.org/wiki/index.php/Symbian_Documentation_Q&As
q
q
TPIP filtering
q Removal of inappropriate content (profanities, information
specific to any single company)
q

q Removal of code snippets where the code is TPIP
q

q Removal of any discussion about TPIP
q

q Removal of any discussion of features or functions that are not
contributed to the Symbian platform
q

q Removal of code snippets relating to features or functions that
are not contributed to the Symbian platform
q

q Removal of legacy branding (e.g. Symbian Software logos)
and material associated with other company's trademarks
E n g in e e rin g d o cu m e n ta tio n co n td
qWhy share the docs?
qYou may not think they’re useful, but external developers find background information
about a package invaluable
qIt’ll reduce your support time.

qWhat if it’s out of date?
qSometimes, the historical information is still very useful
qWe suggest you make a note of when the date was last updated on the first page, and
include the text “Warning: This document was last updated on <date> and may
not be completely up-to-date. Please refer to the product reference library and
the source code in Mercurial, and consult the package owner if in doubt”
q
qHow do I know it’s ready to publish?
qCheck We can help you
it for TPIP (details on our Q&A page) publish docs about
qCheck with your manager, or Lars, if in doubt your package.
Mail us at
qE-mail docs@symbian.org for help
docs@symbian . org
q for more
information!
qFind out more:
http://developer.symbian.org/wiki/index.php/Symbian_Documentation_Q&As
q

q
q
W iki
qHow complete is your package wiki
qHave you got a user page?
q
qWe can help structure your wiki to
promote your package…
q…we can arrange to put your
package on the home page
q…or promote the package
through the developer
newsletter
q
qTalk to us docs@symbian.org
q
q Let us know how
we can help
Q u e stio n s?
q
q
q
q
q
q
q
q

Any
question
s?
O b je cts & style s
Highlight text with these – just stretch & pull to make them fit

Find direction…

Keep things plain & simple…use colour fill only…
qno lines around shapes
qno drop shadows

qno reflections

qno rounded corners on squares

qflat 2D shapes are ideal

If you’re looking to add some spice just add colour…see next
slide
Illu stra tio n s – 1 o f 3
These illustrations are saved at 30% of their
actual size so scale up for a bigger impact
Illu stra tio n s – 2 o f 3
Illu stra tio n s – 3 o f 3