Doctypes for App Manuals

Document macros, page blueprints, space blueprints, and components of your Confluence add-on.

Categories
/ projectdoc / Doctype Add-on
Tags
Doctype Add-on
Status
AVAILABLE SOON
Source Repository
Bitbucket
Available on Bitbucket!

Fork this add-on on Bitbucket!

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:

  1. App
  2. App Component
  3. App Extension
  4. App Macro
  5. App Parameter
  6. App Platform
  7. App Service
  8. App Tool
  9. Doctype
  10. Document Property
  11. Document Section
  12. Page Blueprint
  13. Space Blueprint
  14. Space Property
Install additional Doctypes!

Install additional Doctype Add-ons now and for free via

Atlassian Marketplace
Atlassian Marketplace

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:

1. Install projectdoc Toolbox

Install add-on now

Atlassian Marketplace
Atlassian Marketplace

2. Install Information Systems Extension!

Install the Information Systems Extension add-on now and for free

Atlassian Marketplace
Atlassian Marketplace

3. Install Core Doctypes!

Install the Core doctype add-on now and for free

Atlassian Marketplace
Atlassian Marketplace

List of Doctypes

The following doctypes help Confluence developers to document their add-ons.

# Name Short Description Since Categories
1
App
Document your app for your users and customers.
1.0
/ Doctype / API
2
App Component
Provide more detailed information about a component of a tool.
1.0
/ Doctype / API
3
App Component Type

Document the purpose and usage of the components of this type.
1.0
/ Doctype / Type
4
App Extension
Document your extension for your users and customers.
1.0
/ Doctype / API
5
App Extension Type

Document the purpose and usage of the extension of this type.
1.0
/ Doctype / Type
6
App Macro
Document the purpose and usage of the macro.
1.0
/ Doctype / API
7
App Macro Type

Document the purpose and usage of the macros of this type.
1.0
/ Doctype / Type
8
App Parameter

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
App Parameter Type

Document the purpose and usage of the app parameters of this type.
1.0
/ Doctype / Type
10
App Platform
Document a platform for apps.
1.0
/ Doctype / API
11
App Platform Type

Document the purpose and usage of the platforms of this type.
1.0
/ Doctype / Type
12
App Service
Document a service provided by an app.
1.0
/ Doctype / API
13
App Service Type

Document the purpose and usage of the app services of this type.
1.0
/ Doctype / Type
14
App Tool
Document a tool provided by an app.
1.0
/ Doctype / API
15
App Tool Type

Document the purpose and usage of the app tools of this type.
1.0
/ Doctype / Type
16
App Type

Document the purpose and usage of the apps of this type.
1.0
/ Doctype / Type
17
Doctype
Document the usage of a doctype for your users.
1.0
/ Doctype / API
18
Doctype Type

Document the purpose and usage of the doctypes of this type.
1.0
/ Doctype / Type
19
Document Property
Document the usage of a document property for your users.
1.0
/ Doctype / API
20
Document Property Type

Document the purpose and usage of the properties of this type.
1.0
/ Doctype / Type
21
Document Section
Document the usage of a document section for your users.
1.0
/ Doctype / API
22
Document Section

Document the purpose and usage of the sections of this type.
1.0
/ Doctype / Type
23
Page Blueprint
Document the purpose and usage of a page blueprint.
1.0
/ Doctype / API
24
Page Blueprint Type

Document the purpose and usage of the page blueprints of this type.
1.0
/ Doctype / Type
25
Space Blueprint
Document the purpose and usage of a space blueprint.
1.0
/ Doctype / API
26
Space Blueprint Type

Document the purpose and usage of the space blueprints of this type.
1.0
/ Add-on / Type
27
Space Property
Space properties hold metadata of a space. They may be inherited by delegate spaces.
1.0
/ Doctype / API
28
Space Property Type

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

  • Doctypes - more doctypes for projectdoc.
  • Macros - macros to be used in your doctype templates.