projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 3

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version 4

changes.mady.by.user Robert Reiner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleProperties


Transclusion
documentNote Box referencing common Document Properties
idsBox


Section
titleSuperordinate Application

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

The value is typically automatically provided by the parent document.


Section
titleType

Specify the type of the application to organize them.

Use the Application Type to define types of applications.


Section
titleLifecycle Phase

Specify the lifecycle phase this application is currently in.


Section
titleDocumentation

List documentation assets provided for this application.

Section
titleSoftware

List software assets this application depends on.

Section
titleAssets

List assets this application depends on.

Section
titleConfiguration Items

List configuration items this application depends on to be operational.

Section
titleStatus

Select the status of the application.

Use Configuration Item Status to document statuses.


Section
titleVersion

Specify the version of the application.


Section
titleURI

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

This information may be used by the Access Information doctype.


Section
titleLocation

Specify where the application is located.


Section
titleDocumentation

List documentation assets provided for this application.


Section
titleSoftware

List software assets this application depends on.


Section
titleAssets

List assets this application depends on.


Section
titleConfiguration Items

List configuration items this application depends on to be operational.


Section
titleVendor Organization

Reference the organization that sells the application.


Section
titleVendor Contact

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


Section
titleAdministration Organization

Reference the organization that runs the application.


Section
titleAdministrator

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


Section
titleRemote Repositories

List of remote information repositories related to the application.



Section
titleSections


Section
titleDescription

Describe the application.


Section
titleDependencies

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.


Section
titleInterfaces

List and describe the interfaces provided by this application.


Section
titleInstallation

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.


Section
titleConfiguration

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.


Section
titleBest Practices

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


Section
titleDeployments

List of deployments conducted for this application.


Section
titleAccess Information

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


Transclusion
documentDocument Sections
idsstandard-sections-bottom


...

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH