- Created by Robert Reiner, last modified on 23. Oct 2020
projectdoc Toolbox
IT Services provide business relevant services for customers.
- ID
it-service- Suite
- Parent
- Documentation Type
- Categories
Provides information on an IT service of a service portfolio.
Properties
The document type it-service provides the following properties:
Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.
Superordinate Service
Services may be composed. This is a reference to the superordinate service.
The value is typically automatically provided by the parent document.
Type
Specify the type of the service to organize them.
Use the IT Service Type to define types of services.
Lifecycle Phase
Specify the lifecycle phase this service is currently in.
Since 3.3
Since version 3.3 the Name List Macro selects on lifecycle phases that belong to the lifecycle Process Lifecycle.
If this does not suite your use case, please update the Where parameter accordingly.
Classification
Provide one or more classifications for this service.
Check the type documentation of the classification to understand how classifiers of different types are intended to be applied.
Version
Specify the version of the service.
Service ID
Provide the service identifying part of the URI. Is usually appended to the URI of the service this service is installed to.
URI
Specify the uniform resource identifier (URI) to the service.
This information may be used by the Access Information doctype.
Documentation
List documentation assets provided for this service.
IT Services
Add links to services this services depends on. Services will be rendered within a document section.
IT Processes
Add links to processes this services depends on. Processes will be rendered within a document section.
Customer Assets
Add links to assets provided by the customer this services depends on. Customer assets will be rendered within a document section.
Service Assets
Add links to assets provided by the service provider this services depends on. Service assets will be rendered within a document section.
Applications
Add links to applications this services depends on. Applications will be rendered within a document section.
IT Systems
Add links to systems this services depends on. Systems will be rendered within a document section.
Configuration Items
Add links to configuration items this service depends on. Configuration items will be rendered within a document section.
IT Functions
Add links to functions this services depends on. Functions will be rendered within a document section.
User Roles
List roles using this service.
Customer Roles
List roles that are customers for the service. If the customers are not to be listed individually, you can specify them by their roles.
Customer Organization
List the organizations that are customers for this service.
Customer Contact
Provide information to get in touch with a customer representative.
Service Provider Organization
List the organization that provides the service.
Service Provider Contact
Provide information to get in touch with a representative for business issues.
Service Provider Technical Contact
Provide information to get in touch with a representative for technical issues.
Versions Information
Provide a reference to information on different versions of this service.
Remote Repositories
List of remote information repositories related to the service.
Sections
Description
Describe the service.
Extensions
More information on this IT service.
IT Services
Automatic list of subordinate IT services.
List of IT Services
Lists services referenced by the IT Services property.
List of IT Processes
Lists processes referenced by the IT Processes property.
Documentation Assets
Lists processes referenced by the Documentation property.
List of Applications
Lists applications referenced by the Applications property.
List of IT Systems
Lists systems referenced by the IT Systems property.
Own Configuration Items
List of configuration items used exclusively by this service.
Common Configuration Items
Lists configuration items referenced by the Configuration Items property.
List of IT Functions
Lists functions referenced by the IT Function property.
Interfaces
Provide information on or references to information material that documents the interface the service provides.
Service Level Agreements
Provide information on or references to information material that documents the service level the service provides.
Used by
Automatic list of services that are used by this service.
Notes
These are internal notes that are usually not exported and only visible to team members with write access.
But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.
The text of notes sections is also indexed.
References
For a document the references section contains pointers to resources that prove the statements of the document.
Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.
For further information please refer to References and Resources.
Resources
The resources section provides references to further information to the topic of the document.
This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.
For further information please refer to References and Resources.
