Document macros, page blueprints, space blueprints, and components of your Confluence add-on.
Overview
This doctype add-on provides space and page blueprints to document Confluence add-ons with the projectdoc Toolbox.
Doctypes for the following elements of an app for Confluence are provided:
Prerequisites
The Doctypes for Add-on Developers requires the projectdoc Toolbox to be installed. The projectdoc Toolbox has a commercial license.
The add-on also uses blueprints from the Core Doctypes for projectdoc (like Role or Stakeholder). This add-on is available on the Atlassian Marketplace for free.
Please install the following add-ons on your Atlassian Confluence server:
List of Doctypes
The following doctypes help Confluence developers to document their add-ons.
| # | Name | Short Description | Since | Categories |
|---|---|---|---|---|
| 1 | Document your app for your users and customers. |
1.0 |
/ Doctype / API |
|
| 2 | Provide more detailed information about a component of a tool. |
1.0 |
/ Doctype / API |
|
| 3 | Document the purpose and usage of the components of this type. |
1.0 |
/ Doctype / Type |
|
| 4 | Document your extension for your users and customers. |
1.0 |
/ Doctype / API |
|
| 5 | Document the purpose and usage of the extension of this type. |
1.0 |
/ Doctype / Type |
|
| 6 | Document the purpose and usage of the macro. |
1.0 |
/ Doctype / API |
|
| 7 | Document the purpose and usage of the macros of this type. |
1.0 |
/ Doctype / Type |
|
| 8 | A parameter is a configuration option. Parameter exist on different layers. Wizard and macro parameters are configuration options. Use parameter types to organize them! |
1.0 |
/ Doctype / API |
|
| 9 | Document the purpose and usage of the app parameters of this type. |
1.0 |
/ Doctype / Type |
|
| 10 | Document a platform for apps. |
1.0 |
/ Doctype / API |
|
| 11 | Document the purpose and usage of the platforms of this type. |
1.0 |
/ Doctype / Type |
|
| 12 | Document a service provided by an app. |
1.0 |
/ Doctype / API |
|
| 13 | Document the purpose and usage of the app services of this type. |
1.0 |
/ Doctype / Type |
|
| 14 | Document a tool provided by an app. |
1.0 |
/ Doctype / API |
|
| 15 | Document the purpose and usage of the app tools of this type. |
1.0 |
/ Doctype / Type |
|
| 16 | Document the purpose and usage of the apps of this type. |
1.0 |
/ Doctype / Type |
|
| 17 | Document the usage of a doctype for your users. |
1.0 |
/ Doctype / API |
|
| 18 | Document the purpose and usage of the doctypes of this type. |
1.0 |
/ Doctype / Type |
|
| 19 | Document the usage of a document property for your users. |
1.0 |
/ Doctype / API |
|
| 20 | Document the purpose and usage of the properties of this type. |
1.0 |
/ Doctype / Type |
|
| 21 | Document the purpose and usage of the sections of this type. |
1.0 |
/ Doctype / Type |
|
| 22 | Document the usage of a document section for your users. |
1.0 |
/ Doctype / API |
|
| 23 | Document the purpose and usage of a page blueprint. |
1.0 |
/ Doctype / API |
|
| 24 | Document the purpose and usage of the page blueprints of this type. |
1.0 |
/ Doctype / Type |
|
| 25 | Document the purpose and usage of a space blueprint. |
1.0 |
/ Doctype / API |
|
| 26 | Document the purpose and usage of the space blueprints of this type. |
1.0 |
/ Add-on / Type |
|
| 27 | Space properties hold metadata of a space. They may be inherited by delegate spaces. |
1.0 |
/ Doctype / API |
|
| 28 | Document the purpose and usage of the space properties of this type. |
1.0 |
/ Doctype / Type |
We do not expect to meet all your requirements for your documentation. So please feel free to use this set of blueprints as a template to create your own!
Resources
