projectdoc Toolbox

Applications provided functions required by services. Applications may be hosted on one or more systems.

ID
application
Suite
Parent
Documentation Type
Categories
Iteration
Production

Applications are part of environments where products are deployed to. They are required to provide functions needed to conduct services.

Applications are specialized configuration items.

Properties

The document type application 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 Application

Applications may be composed. This is a reference to the superordinate application.

The value is typically automatically provided by the parent document.

Type

Specify the type of the application to organize them.

Use the Application Type to define types of applications.

Lifecycle Phase

Specify the lifecycle phase this application is currently in.

Status

Select the status of the application.

Use Configuration Item Status to document statuses.

Version

Specify the version of the application.

URI

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

This information may be used by the Access Information doctype.

Location

Specify where the application is located.

Documentation

List documentation assets provided for this application.

Software

List software assets this application depends on.

Assets

List assets this application depends on.

Configuration Items

List configuration items this application depends on to be operational.

Vendor Organization

Reference the organization that sells the application.

Vendor Contact

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

Administration Organization

Reference the organization that runs the application.

Administrator

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

Remote Repositories

List of remote information repositories related to the application.

Sections

Description

Describe the application.

Dependencies

This section provides subsections to list information on dependencies.

The tables are automatically populated with references provided as values to properties. So typically this section is not edited manually. New dependencies are added as a value to the respective property.

Interfaces

List and describe the interfaces provided by this application.

Installation

Describe the installation procedure of the application. Use a subsection for each step. This way you can add screen shots or console output to make things very easy. Adding this information is hard on lists. If the installation process is long and complicated, add a checklist or topic as a child document and refer to it from here. In case the installation is automated, just help the user to launch the installation process.

Configuration

Describe the typical or recommended configuration of the application. Again, use subsections for the individual steps. If the configuration process is long and complicated, add a checklist or topic as a child document and refer to it from here.

Best Practices

An automatic list of work instructions relevant for running or working with this application.

Deployments

List of deployments conducted for this application.

Access Information

If there is a document of type Access Information, this information is automatically rendered in this section by transclusion.

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.