Resource

Versions Compared

Old Version 1

changes.mady.by.user Robert Reiner

Saved on 15. Jan 2016

compared with

New Version Current

changes.mady.by.user Robert Reiner

Saved on 21. Oct 2019

Key

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

...

Document Properties Marker

override	false

Short Description	Resources are books, webpages, videocasts relevant for the project. Add important information to your project about resources that lie outside the control of your team.


Doctype	doctype	hide
Name	Resource


ID	`resource`


Suite	Core
Set	Core

hide

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property	Audience

Documentation Type

Name List

doctype	doctype-type
render-no-hits-as-blank	true
names	Q1 - Process
property	Documentation Type

Tags

Tag List

names	Core, Allrounder, External

Iteration

value	finished

hide

Sort Key

hide

Section

index	true
title	Description

A resource document stores information about a resource of information that is relevant for your project.

A resource may be a book about agile testing. The resource document provides information about that book:

Who wrote it?
When had it been published?
Is it available online?

Besides this metadata a resource document also allows to add descriptions and summaries about the resource to allow your team members to understand the relevant parts for your project quickly. It may even be connected to Excerpt document that provide in-depth information on topics of the resource.

...

Section

title	Properties

Transclusion

document	Note Box referencing common Document Properties
ids	Box

Section

Column

Section

level	2
title	Authors

Lists the authors of the resource.

Persons list resources in their bibliography.

Section

level	2
title	Publisher

The publisher or organization responsible for publishing the resource.

Organizations list resources they have published.

Since version 6.1.1.

Section

level	2
title	Type

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

level	2
title	Media Type

Document the media type to categorize the resource by its format.

Valid types are defined by the team as media types.

projectdoc-box-version

since	11.1.0

Available since version 11.1.0 of the Core Doctypes.

projectdoc-section

level	2
title	Version

The version of the document.

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

Section

level	2
title	Publication 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

level	2
title	License

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

Section

level	2
title	LocationSource

Specify where the original 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 hereAdd the URL to the online resource here.

Version Box

since	11.1.0

Since version 11.1.0 of the Core Doctypes this link points to the origin source.

See the Download property for referencing to local copies.

Section

level	2
title	Location

Provide a links to download copies of the resource locally.

Consider to use the format of the file as label for the link (e.g. PDF or XLS).

Version Box

since	11.1.0

Available since version 11.1.0 of the Core Doctypes.

Section

level	2
title	Rating

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

title	Image URL

The image or the URL to an image. The URL 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

title	Sections

Section

Column

Section

level	2
title	Description

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

level	2
title	Summary

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

level	2
title	Excerpt

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

level	2
title	Quotes

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

level	2
title	SubdocumentsSubordinate 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

document	Document Sections
ids	standard-sections-bottom

...

Section

title	References

Section

title	Resources

Display Properties
document Collecting 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.

Piwik Set Multiple Custom Variables

Name	Value
Department	projectdoc
Category	projectdoc-doctype
Type	core

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 1

New Version Current

Key

About

Keep up-to-date!

Powered by