Versions Compared

Key

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

...

Document Properties Marker
overridefalse


Short Description

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.

 
Doctypedoctypehide
NameEvent 
IDevent 
SuiteDeveloper Diaries
SetDeveloper Diarieshide
Parent
Parent Property
parent-doctypetopic
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 
Documentation Type
Name List
doctypedoctype-type
render-no-hits-as-blanktrue
propertyDocumentation Type
 
Categories
Name List
doctypecategory
names/ Work / Journal
propertyCategories
 
Tags
Tag List
namesDeveloper Diary
 
Iteration

Iteration
valuefocusedproduction

hide
Sort Keyhide



Section
indextrue
show-titlefalse
titleDescription

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.

...

Section
titleProperties


Transclusion
documentNote Box referencing common Document Properties
idsBox


Section
titleContinuation ofType

Document the type of the event.


Section
titleContinuation 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.


Section
titleParticipants

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

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

projectdoc-box-version
since7.0.0

This section is available since version 7.0.0.



Section
titleObject

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.

Version Box
since7.0.1

This section is available since version 7.0.1.



Section
titleFile

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.

Version Box
since7.0.0

This section is available since version 7.0.0.



Section
titleRating

A rating on how much fun this event provided.


...

Section
titleSections


Section
titleDescription

All things to remember about this event goes in here.


Section
titleResult

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.

Version Box
since7.0.1

This section is available since version 7.0.1.



Section
titleAssets

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


Section
titleWorklog

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.

Version Box
since7.0.1

This section is available since version 7.0.1.



Section
titleTodos

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


Section
titleAttachments

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.


Section
titleSubordinate 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.


Section
titlePrevious 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.


Transclusion
documentDocument Sections
idsstandard-sections-bottom


...