building a community through documentation
TRANSCRIPT
-
8/14/2019 Building a Community through Documentation
1/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 nPromoting your package effectively
How?Where?
Who?
-
8/14/2019 Building a Community through Documentation
2/13
D o cu m e n ta tio n fo r a p a cka g eqReference libraryq
qEngineering documentationq
qWiki documentation
qPackage summary
qBacklog
qNews
qContact information (wiki user pages)
qTechnical articlesq
qSocial networking
qForum posts
qBlog postsqMailing lists
q
q
q
q
q
Do you havea wiki userpage?
-
8/14/2019 Building a Community through Documentation
3/13
R e fe re n ce lib ra ry
qReference library documentation is published on developer.symbian.orgqThis provides API reference for your package (from doxygen comments).
qThere is also some guide material.
qTake a look athttp://developer.symbian.org/main/documentation/reference/s^3
q
qThe current version is the first attempt and is missing some packages.
q
A new version will be published in week 02.qWe will then ask you to check that the reference contains your package
qand that its accurate.
q
q
q
q
q
q
q
How do you
use thereference
library?
http://developer.symbian.org/main/documentation/reference/s%5E3http://developer.symbian.org/main/documentation/reference/s%5E3 -
8/14/2019 Building a Community through Documentation
4/13
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 architecturedocumentation you want to promote to package users.
q
There'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
q
q
qFind out morehttp://developer.symbian.org/wiki/index.php/Symbian_Documentation_Q&As
q
q
Use swdocwikifor your
architecturedocs
http://tiny.symbian.org/AgileBrowserStatshttp://developer.symbian.org/wiki/index.php/Symbian_Documentation_Q&Ashttp://developer.symbian.org/wiki/index.php/Symbian_Documentation_Q&Ashttp://tiny.symbian.org/AgileBrowserStats -
8/14/2019 Building a Community through Documentation
5/13
TPIP filtering
q Removal of inappropriate content (profanities, information
specific to any single company)q
q Removal of code snippets where the code is TPIPq
q Removal of any discussion about TPIPq
q Removal of any discussion of features or functions that are notcontributed to the Symbian platform
q
q Removal of code snippets relating to features or functions thatare 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
-
8/14/2019 Building a Community through Documentation
6/13
E n g in e e rin g d o cu m e n ta tio n co n tdqWhy share the docs?
qYou may not think theyre useful, but external developers find background information
about a package invaluableqItll reduce your support time.
qWhat if its 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, andinclude the text Warning: This document was last updated on and may
not be completely up-to-date. Please refer to the product reference library andthe source code in Mercurial, and consult the package owner if in doubt
q
qHow do I know its ready to publish?qCheck it for TPIP (details on our Q&A page)
qCheck with your manager, or Lars, if in doubt
qE-mail [email protected] for help
q
qFind out more:http://developer.symbian.org/wiki/index.php/Symbian_Documentation_Q&As
q
q
q
We can help youpublish docs about
.your package
Mail us at .ocs@symbian orgfor more
!information
mailto:[email protected]://developer.symbian.org/wiki/index.php/Symbian_Documentation_Q&Asmailto:[email protected]:[email protected]:[email protected]://developer.symbian.org/wiki/index.php/Symbian_Documentation_Q&Asmailto:[email protected] -
8/14/2019 Building a Community through Documentation
7/13
W ikiqHow complete is your package wiki
qHave you got a user page?
q
qWe can help structure your wiki topromote your package
qwe can arrange to put yourpackage on the home page
qor promote the packagethrough the developernewsletter
q
qTalk to us [email protected]
q
q Let us know howwe can help
mailto:[email protected]:[email protected] -
8/14/2019 Building a Community through Documentation
8/13
Q u e stio n s?q
q
q
q
q
q
q
q
n yq u e s t i o ns ?
-
8/14/2019 Building a Community through Documentation
9/13
&O b je cts style s
Highlight text with these just stretch & pull to make them fit
Find direction
Keep things plain & simpleuse colour fill only
qno lines around shapesqno drop shadowsqno reflectionsqno rounded corners on squaresqflat 2D shapes are ideal
If you re looking to add some spice just add colour see next
slide
-
8/14/2019 Building a Community through Documentation
10/13
-
8/14/2019 Building a Community through Documentation
11/13
Illu stra tio n s 1 o f 3
%These illustrations are saved at 30 of theiractual size so scale up for a bigger impact
-
8/14/2019 Building a Community through Documentation
12/13
Illu stra tio n s 2 o f 3
-
8/14/2019 Building a Community through Documentation
13/13
Illu stra tio n s 3 o f 3