projectdoc Toolbox

Associated an event with a day. A event is a collection of associated information for your later reference. Information may further be organized by subject, tags, categories, and audience.

The event contains a piece of information that may be of interest in the future. A day is typically a flow of events and each event is in its own event document. That way the events may be referenced easily by a link.

While the event document my feel like a form at first glance, it is not. All properties (besides name and short description) and sections are - as always with the projectdoc Toolbox - strictly optional. But some of them are very handy to quickly organize events and add references to related information.

Properties


The document type event 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.

Type

Document the type of the event.

Continuation of

Provide a link to an event this event continues with. Sometimes topics are investigated over a number of days. With pointing to the last event of investigation the flow of events on a very specific topic is easier to lookup later.

Participants

List the stakeholders, organizations, or persons that participate in this event.

This makes it easier to track events on the participants' documents chronologically.

Since 7.0.0

 

This section is available since version 7.0.0.

Object

Add links to documents that refer to entities this event is concerned with.

If you are configuring a system or service, or follow a work instruction, this can be referenced for further information. It also identifies the entities unambiguously.

Since 7.0.1

 

This section is available since version 7.0.1.

File

Add a link to a todo document this event is related to. The reference may point to any document that serves as a folder for documents belonging to that file.

Since 7.0.0

 

This section is available since version 7.0.0.

Rating

A rating on how much fun this event provided.

Sections

Description

All things to remember about this event goes in here.

Result

Document the result of your work. Are there open issues or has the task been completely resolved?

If there are assets you want to refer to individually, then add asset documents to this event. These documents will be listed automatically in the next section.

Since 7.0.1

 

This section is available since version 7.0.1.

Assets

A list of assets you need to reference explicitly from other documents or you simply want to document separately from this event.

Worklog

Document the intermediate steps of your work that led to your result.

This may help you and others in the future to reevaluate the path to your solution.

You may add open issues as todos to this document. These todos will be automatically listed in the next section.

Since 7.0.1

 

This section is available since version 7.0.1.

Todos

A list of todos you need to reference explicitly from other documents or you simply want to document separately from this event.

Attachments

In case you add documents of any other type than event as child to this page, they will be automatically shown in this section. Again, this is useful if you need to make references to these pieces of information or you want to document them separately.

Subordinate Events

In case you need to divide the information of this event in several events. The only reason to do so is to have each subordinate event referable by its own URL.

Previous Work

This section lists the events that have previously dealt with the same piece of work. This is a listing of the "Continuation of" information.

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.

Related Doctypes

Name Short Description
Describe your vision for one year. You plan will help you stay focussed to accomplish your goals.
Categories for annual visions.
Explain an asset of your work. Add this document to a day in your diary.
Categories for assets.
A brief solution to a problem.
Categories for cheats.

Store relevant information discovered today in your developer diary.

Categories for days.
The homepage of a developer's daily diary pages. Consider to add your diary to your personal space!
Categories for diaries.
Categories for events.

Plan and run a retrospective for your month of work.

Categories for months.
Add a todo note to your developer diary.
Categories for todos.
Describe your vision for your career.
Categories for visions.

Plan and run a retrospective for your week of work.

Categories for weeks.
Create a year in your Diary.
Categories for years.

Resources


Developer Diaries
A short introduction to developer diaries.
Create a Diary in a Personal Space
The recommended way of creating a diary with the Developer's Diary Add-on is to add a page with the Diary Template in one's Personal Space.