projectdoc Toolbox

IT Assets define assets required or produced by processes.

ID
it-asset
Suite
Parent
Documentation Type
Categories

Properties

The document type it-asset 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.

Identifier

Provide an identifier to uniquely reference the asset in your domain.

This allows to keep the same identifier for different documents. The identifier is different from the short name as it is a tiny reference whereas the short name is a shorter word phrase than the name.

Superordinate Asset

Assets may be composed. This is a reference to the superordinate asset.

The value is typically automatically provided by the parent document.

Type

Specify the type of the asset to organize them.

Use the IT Asset Type to define types of assets.

Classification

Provide a link to reference information for this asset. This may be a reference to a space on Confluence this asset document describes.

URI

Specify the uniform resource identifier (URI) to the asset.

This information may be used by the Access Information doctype.

Location

Specify the location of this asset.

Release Notes

A reference to release information for this asset.

Version

Provide the version of the asset.

Publication Date

Provide the date when this asset has been released.

Previous Version

A link to an artifact in a previous version.

Next Version

A link to an artifact in a next version.

Assets

List assets this asset depends on.

Manufacturer Organization

Reference the organization that built the asset.

Manufacturer Contact

Provide contact information to the person of the manufacturer organization to get in touch for information on the asset or related information.

Vendor Organization

Reference the organization that sells the asset.

Vendor Contact

Reference the contact person of the vendor organization to access more information on the asset or related information.

Administration Organization

Reference the organization that runs the asset.

Administrator

Reference the contact person of the administration in case of technical problems.

Location

List of local representations or references to remote information repositories related to the asset.

Sections

Description

Describe the asset.

Central Features

List the central features of this asset.

Best Practices

List best practices related to the asset.

Lists automatically all Work Instructions that are direct children to this document.

Licensing Information

Provide information about the license of the asset.

Utilization

Automatic list of services, systems, configuration items, assets, and application that use this asset.

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.