Documenting Apps

Note

The App documentation is part of the packaged App.

Terminology

Index	Item	Description	Origin
1	Title	App title	‘Title’ field in the App. Set during App creation.
2	Company	Company which maintains the App	Company the uploading account belongs to. Set during App creation.
3	App description	App short description	‘Description’ field in the App. Set during App creation.
4	Splash description	Some information about the App, e.g. for advertising it	doc/README.md from the App. See below how to edit it.
5	Link to complete documentation	Complete App documentation	Something referenced from within the doc/README.md. Can be a PDF, a link to some external site, …

Note

An App (.addon file) is technically a ZIP file. See App file format for details.

Mandatory contents:
- doc/README.md — this will be rendered as the product’s splash description ad.
- Releasenotes.md and Releasenotes.pdf — The Markdown file allows viewing in the App Editor while the PDF file is used in the ZEISS Quality Software Store.
Recommended contents:
- Documentation.md (and optional Documentation.pdf) — full App documentation

The App can contain an arbitrary number of additional files in the doc folder referenced from within the files README.md or Documentation.md.

Documentation related content of the App ‘Python API Examples’:
The README.md is the starting point for rendering the App’s splash description and will reference other files:
This will result in the following splash description:

Note

See markdown guide for a brief description of the markdown format.

A markdown editor/viewer is integrated in the ZEISS INSPECT App editor.

The standard expression to reference a PDF from doc/README.md is:

doc/README.md

See [Documentation](Documentation.pdf) for detailed description.

The Visual Studio Code extension Markdown PDF allows to convert a Markdown file to PDF.