projectdoc Toolbox

Get users started with collecting external information that is relevant for their project. Each piece of information is referenced by a resource document. Excerpts and quotes are used to catch detailed information and make it referenceable.

The document explains how to use the Resource Doctype to collect external information that is relevant for a project.

Contents

 

Create a Space

The library may be part of your project space or in a separate space. If you choose to create a separate space, the topic space may be the most appropriate type of space.

The space provides home pages for resources, quotes, persons, and organizations.

The overview section may provide information for users on how to work with the library. Tours may provide manually created lists of introductory material or resources that are relevant for a given task. You may also create a glossary for the terms of the domains in this space.

Use the Resource Doctype

For each relevant information add a resource document that references this information.

The resource documents will automatically be collected on the Resource Doctype's Index Page. Usually you will add the resource document to the Resource Doctype's Homepage, which forms the library of external resources.

 

For more information about this concept: Home and Index Pages. 

Specify the Resource Type

Add the appropriate Resource Type to the resource document in order to structure the resources by their type.

A website provides information that differs from a book. Adding the resource type sets the right expectations by readers and allows this value to be rendered in lists.

 

In order to use the resource type, you have to select and create documents for the types that are relevant for your project. You may want to refer to Resource Types (Prototypes) to get you started with some examples.

Use Categories and Tags

To provide different views on the resources of your library, define categories and tags using the Category and Tag Doctype.

You may further organize your library by defining audiences and subjects.

Each resource is then associated with the intended audience, a subject, categories, tags.

Assume to define a category '/ Information Architecture'. Then associate a book with this category.

The resource in view mode:

By clicking on a category '/ Information Architecture' users are able to examine other resources for this category that are available in the library.

Use Excerpts and Quotes

For resources such as books, you may want to take notes of the relevant information. You may either add these notes to the resource document directly or add subordinate documents in form of excerpts. Excerpts help to keep the structure of the original resource or impose a structure more suitable for you project. If you quote from a resource, use the Quote Macro. The resource's metadata relevant for quoting will be automatically collected.

For important facts you may want to be more precise and make this single information available for reference. In this case use the Quote Doctype and use the Quote Macro to single out this important information.

 

 

Up from version 1.2.1, this metadata collection also works for Excerpt and Quote Doctypes.

Name the Author

 If you reference the author of a resource that matches a person document, the resources and quotes for that person are automatically collected.

 

Example with Jurgen Appelo from our Library

 

The following example is taken from our internal library at smartics. It shows the books written by Jurgen Appelo and (some of the) quotes found in these books.Example person document for Jurgen Appelo from our documentation

Person documents will themselves be collected in a person register on the Person Doctype's Home and Index Pages.

 

If you want to factor out information for authors that work together within an organisation, use the Organization Doctype.

Resources

Library
Create a library for your project. Reference books, podcasts, videos, and other resources that provide information on the topics relevant for your project.
Finding without Searching
Blog article on how to organize a wiki to increase the findability of information.
Finding without Searching - applied!
Blog article on how to use the projectdoc Toolbox to organize information in a Confluence wiki.
Software Architecture Documentation
Communicate the quality targets, context, and design drivers of your software architecture.
Domain Crunching
Collect and maintain information relevant for your team, project, or organization collaboratively.
Journals
You want to track your findings? Either with your team or individual? The projectdoc Toolbox supports teams to create project or team journals and individual team members to keep a professional diary.
Paperwork
Collaborate to create documents for your stakeholders as a team.