- Created by Robert Reiner, last modified on 27. Aug 2020
projectdoc Toolbox
Document macros, page blueprints, space blueprints, and components of your Confluence add-on.
- Categories
- Tags
- Status
- AVAILABLE SOON
- Source Repository
English and German by Default
All doctype add-ons are available in English and German language (except for the V-Modell XT add-on for which only German is supported).
For more information on this topic please refer to Localization.
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:
- App
- App Component
- App Extension
- App Macro
- App Parameter
- App Platform
- App Service
- App Tool
- Doctype
- Document Property
- Document Section
- Page Blueprint
- Space Blueprint
- Space Property
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.
For some features the Information Systems Extension is required. This add-on is also 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 |
||
2 | Provide more detailed information about a component of a tool. |
1.0 |
||
3 | Document the purpose and usage of the components of this type. |
1.0 |
||
4 | Document your extension for your users and customers. |
1.0 |
||
5 | Document the purpose and usage of the extension of this type. |
1.0 |
||
6 | Document the purpose and usage of the macro. |
1.0 |
||
7 | Document the purpose and usage of the macros of this type. |
1.0 |
||
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 |
||
9 | Document the purpose and usage of the app parameters of this type. |
1.0 |
||
10 | Document a platform for apps. |
1.0 |
||
11 | Document the purpose and usage of the platforms of this type. |
1.0 |
||
12 | Document a service provided by an app. |
1.0 |
||
13 | Document the purpose and usage of the app services of this type. |
1.0 |
||
14 | Document a tool provided by an app. |
1.0 |
||
15 | Document the purpose and usage of the app tools of this type. |
1.0 |
||
16 | Document the purpose and usage of the apps of this type. |
1.0 |
||
17 | Document the usage of a doctype for your users. |
1.0 |
||
18 | Document the purpose and usage of the doctypes of this type. |
1.0 |
||
19 | Document the usage of a document property for your users. |
1.0 |
||
20 | Document the purpose and usage of the properties of this type. |
1.0 |
||
21 | Document the purpose and usage of the sections of this type. |
1.0 |
||
22 | Document the usage of a document section for your users. |
1.0 |
||
23 | Document the purpose and usage of a page blueprint. |
1.0 |
||
24 | Document the purpose and usage of the page blueprints of this type. |
1.0 |
||
25 | Document the purpose and usage of a space blueprint. |
1.0 |
||
26 | Document the purpose and usage of the space blueprints of this type. |
1.0 |
||
27 | Space properties hold metadata of a space. They may be inherited by delegate spaces. |
1.0 |
||
28 | Document the purpose and usage of the space properties of this type. |
1.0 |
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!
- No labels