projectdoc Toolbox

Provides doctypes to document services and systems.

Categories
Status
AVAILABLE SOON
Requires projectdoc
2.4.0
Source Repository

This add-on provides document types to document services and systems of an organization based on the projectdoc Toolbox for Confluence.

The document types (or blueprints) allow to document service management from a strategic point of view. Define types of services and systems and create a documentation that is easy to navigate! The projectdoc Toolbox also supports teams to integrate information from remote information systems via the Web API Extension (based on REST) or the Information Systems Extension. With the Web API Extension information can be pushed into projectdoc documents, while the Information Systems Extension provides macros to link or transclude information.

 

See Confluence as the Information Hub as an introduction to integration options.

Your approach may be based on any framework, such as the IT Infrastructure Library (ITIL) managed by AXELOS. If the pre-configured set of blueprints do not meet your requirements or your selected framework, you may adjust them using the sources published on Bitbucket.

 

This project is in an early state of development. It is not bound to a particular framework or approach.

If you decide to build your own version of service management doctypes, have a look at the Doctype Maven Plugin to model your documents and create a blueprint add-on for Confluence Server.

Prerequisites

The Doctypes for Service Management requires the projectdoc Toolbox to be installed. The projectdoc Toolbox has a commercial license and is available on the Atlassian Marketplace.

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

Space Blueprint

The add-on provides a blueprint to create a space for service management.

List of Doctypes

The following doctypes help to document and manage services.

Additional doctypes supporting service management documentation are found in the Core Doctypes (e.g. Roles, Stakeholders, and Tours).

# Name Short Description
1
Credentials for development systems where the password is known to all who have access to the Confluence wiki.
2
Type-specific category for access information.
3
Applications provided functions required by services. Applications may be hosted on one or more systems.
4
Type-specific category for applications.
5
Configuration items (CIs) may be (sub-)systems or components. Whatever may change and needs to be tracked may be documented as a CI.
6
Signals the status of an IT system, application, or a configuration item.
7
Type-specific category for configuration items.
8
Datasets are used as the input and output of processes.
9
Type-specific category for datasets.
10
Deployments are requested and fulfilled. This instructs a member of the delivery team to provision an environment with a specific system.
11
Type-specific category for deployments.
12
Impacts define how the results of processes affect the world.
13
Type-specific category for impacts.
14
IT Activities define activities for processes.
15
Type-specific category for IT activities.
16
IT Assets define assets required or produced by processes.
17
Type-specific category for IT assets.
18
Functions are specialized organizational units to support business processes.
19
Type-specific category for IT functions.
20
IT Procedures define procedures for processes.
21
Type-specific category for IT procedures.
22
Processes organize activities to create a defined business value.
23
Type-specific category for IT processes.
24
IT Services provide business relevant services for customers.
25
Classifiers to categorize services.
26
Type-specific classification for IT services.
27
Signals the status of an IT Service.
28
Type-specific category for IT services.
29
Systems are part of environments where products are deployed to.
30
Systems are categorized by their type. These types may be quite concrete since systems by nature reference a hard- or software system usually by their IP address or DNS name. Therefore a system type may be 'Artifact Repository' or 'Virtual Server. And types may build hierarchies.
31
Add lifecycles to group lifecycle phases.
32
Lifecycle phases define phases that are bound to a lifecycle.
33
Locations provide information about the whereabouts of assets, configuration items, and systems.
34
Type-specific category for locations.
35
Outcomes define the results of processes.
36
Type-specific category for outcomes.
37
Describe a service level for a service.
38
Provide information about a service level agreement (SLA).
39
Type-specific category for service level agreements.
40
Describe a requirement in terms of a service level.
41
Type-specific category for service level requirements.
42
Type-specific category for service levels.
43
Defines a strategy for an organization or product.
44
Type-specific category for strategies.
45
Work on strengths, weaknesses, opportunities, and threats.
46
Type-specific category for SWOTs.
47
Triggers define signals for activities and processes.
48
Type-specific category for triggers.
49
Work Instructions define procedures for processes. Provide the most detailed information here how tasks are to be executed. This includes best practices.
50
Type-specific category for work instructions.

Resources

Doctypes
Doctypes define properties and sections for documents. They are essentially Confluence Blueprints that help to create pages in your wiki based on templates.
Doctypes Overview
List of all doctypes provided by add-ons. Provides an overview over doctype IDs and blueprint keys.
Macros
List of macros provided by the projectdoc Toolbox.