Versions Compared

Key

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

...

Section
titleProperties
Transclusion
documentNote Box referencing common Document Properties
idsBox

Section
Column
Section
level2
titleAuthors

Lists the authors of the resource.

Section
level2
titleType

The type of the document.This allows the reader to judge how the information will be presented.

Valid types are defined by the team as resource types.

Section
level2
titleVersion

The version of the document.

For a book this is the edition. Other documents may provide a numbered version.

Section
level2
titlePublication Date

The date at which the resource has been published. May be the year only or more precise.

This may help readers to set several resources into context.

Column
Section
level2
titleLicense

If there is a license that explains the defined usage of the resource, reference it here.

Section
level2
titleLocation

Specify where the resource is located. It may be available in the internet, on a team server, attached to the wiki page or a hardcopy in the library. If it can be accessed online, add the URL to the resource here.

Section
level2
titleRating

Rate the relevance and accuracy of the information provided in the resource. This should help team members to judge in advance, what can be expected.

Section
titleImage URL

The URL to an image. May be a plain URL or a link that points to an image.

Typically the URL is used to fetch the image and render it using the Display Document Property As Image Macro.

Section
titleSections
Section
Column
Section
level2
titleDescription

A description of the content. This is the longer version of the short description that should help readers to decide, whether or not reading the resource will help them for their demand.

Often the short description is enough. So leave this blank.

Section
level2
titleSummary

The summary describes the content of the book in a few paragraphs. Other than the description, which describes the topic of the book, a summary holds is essence.

There is often no time to write effective summaries on a project. In this case leave this empty and go with a short description and the most helpful excerpts.

Section
level2
titleExcerpt

This section contains the excerpts that express the topics of the resource in more depth. For a book there might be one excerpt per chapter, if this information is relevant for the project.

If you can keep it short, replace the list with information added as subsections.

Section
level2
titleQuotes

A collection of quotes taken from the resource that are relevant for the project to be referenced from elsewhere in your documentation.

While most quotes may be located directly in any doctype, using the Quote Macro, the important once may be added as child pages to the resource document. Note that these quotes will show up on the index page of the Quote Doctype.

Section
level2
titleSubdocumentsSubordinate Documents

For some resources there is a natural partitioning of a document. There might be a business rule that is split in several subordinate document. You may want to track different versions of a resource where the latest is referenced by the main resource document.

If you do not need to make this relationship visible, skip this section.

Column
Transclusion
documentDocument Sections
idsstandard-sections-bottom

...

Section
titleReferences

Section
titleResources
  • Display Properties
    documentCollecting Information
  • External Resources - List of references to external information. This allows to link to an external resource that is not in control of the team and add information that is relevant to the project.