Versions Compared

Key

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

Document Properties Marker
overridefalse


Short DescriptionIn order to take personal notes on one's own work and to reflect upon what has to be done or has been done, keep a journal. The information in the journal should be shareable at least with all team members.
Doctypepatternhide
NameKeep a Journal
Short Name
Parent
Parent Property
property-nameName

Audience
Name List
doctyperole
propertyAudience

Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags
Tag List
propertyTags

Domain

Name List
doctypepattern-domain
namesDocumentation
propertyDomain


Type

Name List
doctypepattern-type
namesKnowledge Organization
propertyType


PrinciplesKISS Principle, YAGNI Principle, Teamwork, Separation of Concerns
Iteration

Iteration
valuefinished

hide
Sort Keyhide



Section
titleDescription


Section
titleExample


Section
show-titlefalse
titleContext

There is information that may be relevant in the future. Team members or teams need some location where information can be dropped in an unstructured manner and referred to it later.


Section
show-titlefalse
titleProblem


Panel

A personal journal or diary supports personal learning. Not every piece that is relevant for a team member may be relevant for the team or a stakeholder. Nonetheless the team member may want to add a record for an information or insight that she may pursue later.

The benefit of such a record is that it is searchable. It may also be organized by categorization. Especially Subjects are a handy tool to keep track on observation on a given topic. On the subject homepage the events will be automatically tracked.



Section
titleStructure

A journal organized events of interest on a timeline. The keeper of the journal may recall important information easier since it may be accessed in multiple ways. One is via the timeline, the others are Provide multiple Views defined by the keeper.

This approach supports "Document First" in an unagitated manner - so it can be applied where it is relevant and introduces no maintenance costs once the information is regarded as not worthy enough to invest in it.


Section
titleAdvantages

Authors may think through more thoroughly a piece of work before it is conducted. They may collect information on a given topic in a highly unstructured manner. Later - once all relevant information on the topic is collected - the author may decide whether the investment to preserve the information in a more elaborate state is justifying the investment.

Authors of a journal may reflect on work that has been done as part of their personal review. It may also serve as a notebook to prepare team retrospectives.


Section
titleDisadvantages

Keeping a journal takes time, making the information quickly findable needs some practice. If there are multiple entries with very similar information having these pages organized by time may actually finding relevant information much harder. To address this, information should not be duplicated and an entry that carries forward a task started in the past may simply refer to the original event (or delegate to it) and collect the additional information in one location.

A journal may bury information that is relevant for the whole team and should therefore be located in the team space and maintained by the team. To address this problem a journal keeper should communicate each piece of information to the team. The team may then decide collaboratively which information should be preserved in which form in which location.

This practice may collide with the Know your Mission practice: Charters have similar information, which is - in contrast to journals - dedicated to be read by all stakeholders (not only the author or the team). So to collect information in the journal and on the charter document must be avoided. To address this problem it is recommended that the event document references the charter document.


Section
titleVariants

There are two variants to collect information in a defined, yet unstructured way.

Section
titleTeam Journals

Teams may keep a journal to log information that is relevant for the whole team.

The projectdoc Toolbox provides the Iteration doctype to track this information.


Section
titleProject Journals

For larger projects there may be information that is relevant for the whole project, not only for teams. In order to not have the burden of keeping these pieces of information up-to-date, they may be logged into a project journal.

The drawback with this approach is when new team members have to wade through the journal, not knowing if the information in a particular event is still relevant today. Therefore there is still the need for introduction material that is kept up-to-date.



Section
titleSubordinate Patterns
Display Table
doctypepattern
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name


Section
titleRelated Practices
intro-textThe following practices are related to this practice.


Tour
render-as-definition-listtrue
replace-title-with-nametrue





Section
required-permissionswrite-access
titleNotes


Section
titleReferences


Section
titleResources
intro-textFor more information regarding this practice please refer to:


Tour
render-as-definition-listtrue
replace-title-with-nametrue





Piwik Set Multiple Custom Variables


NameValue
Departmentagiledoc
Categorypractice
Typedocumentation