You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

projectdoc Toolbox

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 PDOC.

Templates for the following elements are provided:

The query matched no documents.

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:

1. Install projectdoc Toolbox

List of Doctypes

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

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

Document the purpose and usage of the components of this type.

1.0
/ Doctype / Type
4App Extension
Document your extension for your users and customers.
1.0
/ Doctype / API
5App Extension Type

Document the purpose and usage of the extension of this type.

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

Document the purpose and usage of the macros of this type.

1.0
/ Doctype / Type
8App 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
9App Parameter Type

Document the purpose and usage of the app parameters of this type.

1.0
/ Doctype / Type
10App Platform
Document a platform for apps.
1.0
/ Doctype / API
11App Platform Type

Document the purpose and usage of the platforms of this type.

1.0
/ Doctype / Type
12App Service
Document a service provided by an app.
1.0
/ Doctype / API
13App Service Type

Document the purpose and usage of the app services of this type.

1.0
/ Doctype / Type
14App Tool
Document a tool provided by an app.
1.0
/ Doctype / API
15App Tool Type

Document the purpose and usage of the app tools of this type.

1.0
/ Doctype / Type
16App Type

Document the purpose and usage of the apps of this type.

1.0
/ Doctype / Type
17Doctype
Document the usage of a doctype for your users.
1.0
/ Doctype / API
18Doctype Type

Document the purpose and usage of the doctypes of this type.

1.0
/ Doctype / Type
19Document Property
Document the usage of a document property for your users.
1.0
/ Doctype / API
20Document Property Type

Document the purpose and usage of the properties of this type.

1.0
/ Doctype / Type
21Document Section
Document the usage of a document section for your users.
1.0
/ Doctype / API
22Document Section

Document the purpose and usage of the sections of this type.

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

Document the purpose and usage of the page blueprints of this type.

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

Document the purpose and usage of the space blueprints of this type.

1.0
/ Add-on / Type
27Space Property
Space properties hold metadata of a space. They may be inherited by delegate spaces.
1.0
/ Doctype / API
28Space 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.


  • No labels