Docs4epl Slides

How to Share Documentation  

Reference library documentation is published on developer.symbian.org      

 

This provides API reference for your package (from doxygen comments) There is also some guide material Take a look at http://developer.symbian.org/main/documentation/reference/s^3

However, developers also like to have engineering documentation to give a background to the package. This could include        

architectural descriptions specifications how-to guides (e.g. how to test the package) information about useful tools, backgrounders etc

We can help you publish docs about your package. Mail us at

[email protected] for more information!

  Find out how to share your documentation: http://developer.symbian.org/wiki/index.php/Symbian_Documentation_Q&As

How to Share Documentation contd  

Why share the docs?  

 

What if it’s out of date?    

 

Sometimes, the historical information is still very useful We 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 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”

How do I know it’s ready to publish?      

 

You may not think they’re useful, but external developers find background information about a package invaluable, particularly where it architecture and specifications

Check it for TPIP (details on our Q&A page) Check with your manager, or Lars, if in doubt E-mail [email protected] for help

We can help you publish docs about your package. Mail us at

[email protected] for more information!

Find out more:

http://developer.symbian.org/wiki/index.php/Symbian_Documentation_Q&As