How to Document the Software

Introduction

Todo:

This how-to guide has to be written yet.

This how-to guides introduces you to the documentation of software as it is supported and required by BASIS.

• ChangeLog Generated from revision history.
• UserManual.pdf Guides user through example application.
• DeveloperManual.pdf Describes implementation details.

• API/ API documentation generated from source code, e.g., using Doxygen, Epydoc, Sphinx,...