Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
extract-short-desctrue
Short DescriptionA short introduction to developer diaries.
 

Doctypetopichide
NameDeveloper Diaries
 

Parent
Parent Property
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience
 

Expected Duration
 

Subject
Name List
doctypesubject
propertySubject
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags

Tag List
namesdeveloper diary, developer journal, Confluence, add-on
propertyTags

hide
Iteration
Iteration
valuefocused
hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
propertyType
 

Sort Key0000100hide
Section
titleDescription

 
Section
titleDescription

Section
Column
Section
titleAbstract

A diary is a very useful tool to add information for and about your work effortless. Since the entries of your diary are records, there is no need to keep them up-to-date. You diary is an invaluable tool to remember bits of information that will otherwise get washed away by the tremendous amount of information you are confronted with every day. It also helps you stay focussed on your tasks and helps to incorporate the continuous improvement process into your daily work. Last but not least, it is also a communication tool with your team mates, since they can also profit from your discoveries and decisions.

Column
width30%
Panel
titleContents

Table of Contents
maxLevel1
indent15px
excludeAbstract
stylesquare

...

Section
Column
Section
titleOrganize your Work

A diary allows you to plan for the day. Working on a plan helps you to get focussed and find important details about the tasks you want to accomplish. Although we know that planning is everything, the plan is nothing, in short iterations it is feasible to try to stick to your plan. This allows you to keep track on how you are doing in closing your tasks.

For every event on you working day, add an event document to your day. This event document will store every piece of information you regard to be valuable for later use. You may even tag these event documents with a subject, categories, and tags. This will make it easier to find related information or keep going on a theme of tasks that you work on over several days.

Note that you should not duplicate the information you already have in your JIRA. Your developer diary will automatically add the list of tasks you fixed on a particular day. If you find it easier to record information in your wiki than in your JIRA task, then create a new page in your wiki. Consider to choose the event doctype and link the new page with your JIRA task.

At the end of your working day, have a look at what you have done and run a short, personal retrospective. Describe what went well and where you can improve. Write it down and define actions to actually act on your insights. This organization of your work will be part of your improvement cycle and will enhance your happiness.

Section
titleTool of Learning

Your diary is one of your tools to learn and improve yourself. Get the things done that are meaningful to your life! It does this by

  • Supporting your planning activities to focus on what is to be done next
  • Logging and therefore remembering what you have done recently
  • Supporting your self-reflection to find obstacles to remove and personal work habits to improve
Quote External
authorOscar Wilde
sourceThe Importance of Being Earnest

I never travel without my diary. One should always have something sensational to read in the train.

You may also put this plan-do-check-act cycle you apply on a daily basis a little but further and start your working week with a short plan you scribble on your week document. Since you are planning for a couple of days, be quite coarse on these topics. But at the end of the week do not miss the chance to run a private retrospective on what you have done and where you can improve.

Column
Panel
borderColororange
titleColorwhite
borderWidth3
titleBGColororange
titleGames make us happy
Section
idGames make us happy

Jane McGonigal tells us why games make us happy:

  1. There is a defined goal to achieve which provides you with a sense of purpose.
  2. There are rules you have to follow that are known in advance.
  3. There is a feedback system that instantaneous allows you to determine you current state of play.
  4. And finally you are voluntary participating: You accept the goal and the rules.

Source:

Cite
template$[Name] (${Authors}, ${Publication Date})
documentPDAC:McGonigal2011
.

Section
level2
titleWork can make us happy

If we align our daily work with this foundations of happy gaming, we have to

  1. define the goal of our work.
  2. know the processes and tools that help us to achieve this goal.
  3. have feedback on what we have already accomplished and what is left to do for us.
  4. make us realize that we have chosen to do the job.
Info Box
titleJob of a Software Developer

For sure this list cannot be matched easily to every job description. Therefore we assume that we focus on work related to software development and software developers in particular. Nonetheless the last one in this list is still not that easy to align with the software developer's daily work. But you can always vote with your feet if you prefer the chance of a change to the better against some form of security. This is certainly a personal decision and we do not want to focus on this one.

Section
level2
titleDiary as a Tool

Instead we want to show that a diary is a valuable tool to achieve the first three by applying the following steps:

  1. Before your start working in the morning, define your goal for the day. State this goals in written form so you can access it quickly.
  2. Know your processes and have your tools prepared to be used.
  3. Have your work broken down into meaningful tasks. These can be checked once you are done with it. The list of accomplished tasks and the list of tasks that still have to be done, is the feedback system to guide you through the day.

The diary will surely not ensure that your work is more structured from the moment you start using it. But it helps you to envision your goal and will help you to find a way to a happy working day, step by step. The overview over events can also easily be used to be prepared for your daily stand-up meeting to communicate your work with your team mates.

...

Section
titleComparison of Tools

Let's briefly further define the scope of a developer diary in contrast of other tools that help you get organized and communicate with your colleagues in your working life.

Section
Column
Section
level2
titleTeam Spaces

Every team should have their own space within the wiki as a tool of collaboration. You may use the Doctypes for Agile Planning to structure your work in iterations. These iteration documents and all subordinate documents you attach to it, are also records that do not have to be updated. There are also documents for retrospectives to support you in your process of continuous improvement.

The difference is that this space and its document is organized by a team of workers that are collectively responsible to keep this a place where you can store and find information easily. The developer diary is written by a single developer. Others may read, but do not edit.

  • Diary: Written by me, used by me. Others may read it.
  • Team Space: Written by us, used by us. Others may read it.
Section
level2
titleBlog

A blog is a sequence of articles you publish to have them read by others. You probably want to get in contact with your readers though comments and discussion on the topics you have written about.

A developer diary on the other side, while not strictly private, is not meant to be discussed. Team members may talk to you over lunch about interesting bits or may even answer questions you have raised, but this is not its main concern. It is the developers log of events, a tool to improve and reflect about the professional goals.

Section
level2
titleTask

While you may use a diary to log tasks, a issue management system, like JIRA, is probably a more convenient place to organize them. Especially if you are not working on them on your own and if you need some source of information for your release notes.

A diary is not a tool to organize your work for a project. It is a tool to organize yourself: the goals you want to reach and identify the parts you want to improve to get more of the things done you are most interested in.

Column
Section
level2
titlePersonal Diary

A personal diary is a private affair. You write your most personal thoughts in it to reflect and overcome personal difficult situations. You usually do not want to share information on this level of privacy with your colleges. Keep these two things separate. A developer's diary is something you do not care to keep secret. On the opposite: You want to share but do not want to be taken responsible for information that may be delusive, not up-to-date or plain wrong.

Section
level2
titleStatus Updates

Sending status updates to your team members via User Status Updates (a Twitter-like messaging system inside Confluence) or HipChat is a very helpful tool to synch your collaborative work. Some teams use these updates to prepare themselves for their daily stand-up.

Diary entries may also be used for daily stand-up preparation, but are certainly no tool to make status updates quickly. Team members may none-the-less access the diaries of the colleagues to update themselves by these discoveries.

Section
level2
titleJournal

A diary may by mistake stress the personal emphasis of a diary. A journal is also a log of events but by definition does not need to be maintained on a daily fashion.

So it is mostly a matter of taste to call this tool 'Journal' or 'Diary'.

Section
level2
titleCodelog

A codelog is often very similar to a developer diary. It may stress on code snippets or technical solutions.

Section
titleDeveloper Diary for projectdocConfluence

projectdoc Developer Diaries provides templates to create your developer diary with Confluence and the projectdoc .
Toolbox. A year is organized in days that collect information about events that are supposed to be relevant for the future. Events may also work for having one's thoughts put straight to paper. Since each event is on its own page, which may seem too much work at first glance, it is easy to refer to it: from a web/wiki page, in a messenger post, or an email.

Section
Column

Image Added

Column
Panel
titleColorwhite
titleBGColor
Section
Column

Image Removed

Column
Panel
titleColorwhite
titleBGColororange
titleprojectdoc Toolbox for Confluence

Install the projectdoc Toolbox for Confluence (free trial) now via

Atlassian MarketplaceImage Modified

Panel
titleColorwhite
titleBGColororange
titleInstall Developer Diary for projectdoc!

Install the Developer Diary for projectdoc now and for free via

Atlassian MarketplaceImage Modified

Panel
borderColororange
borderWidth3

Get started with your developer diary:

Create a Diary in a Personal Space!

Panel
titleColorwhite
titleBGColororange
titleInstall additional Doctypes!

Install additional Doctype Add-ons now and for free via

Atlassian MarketplaceImage Modified

Section
hidetrue
titleSubordinate Topics

Create from template
spaceKeyDEVDIARY
blueprintModuleCompleteKeyde.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-core:projectdoc-blueprint-doctype-topic
contentBlueprintIddce6ebb6-7413-40b3-a8f0-78b91d22ce02
templateNamedce6ebb6-7413-40b3-a8f0-78b91d22ce02
buttonLabelNeues Topic

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

...

Section
titleReferences

Section
titleResources

More on journals with the PDAC1 for Confluence and related information.

Tour
replace-title-with-nametrue