Scribd
Upload
62 views

Docs4EPL Slides

This document provides guidance on how to share documentation for software packages on the Symbian developer platform. It recommends publishing API reference documentation from doxygen comments on developer.symbian.org and also sharing engineering documents that provide architectural descriptions, specifications, how-to guides, and information about useful tools. The document addresses why background documentation is useful for external developers and provides tips for handling outdated documents and ensuring documents are ready to publish.

Uploaded by

Symbian
Copyright
© Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online on Scribd
62 views

Docs4EPL Slides

This document provides guidance on how to share documentation for software packages on the Symbian developer platform. It recommends publishing API reference documentation from doxygen comments on developer.symbian.org and also sharing engineering documents that provide architectural descriptions, specifications, how-to guides, and information about useful tools. The document addresses why background documentation is useful for external developers and provides tips for handling outdated documents and ensuring documents are ready to publish.

Uploaded by

Symbian
Copyright
© Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

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 We can help you
  how-to guides (e.g. how to test the package) publish docs about
your package.
  information about useful tools, backgrounders etc 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?
  You may not think they’re useful, but external developers find background information
about a package invaluable, particularly where it architecture and specifications

  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 <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”

We can help you


  How do I know it’s ready to publish? publish docs about
  Check it for TPIP (details on our Q&A page) your package.
  Check with your manager, or Lars, if in doubt Mail us at
[email protected]
  E-mail [email protected] for help for more
information!
  Find out more:
http://developer.symbian.org/wiki/index.php/Symbian_Documentation_Q&As

You might also like