projectdoc Toolbox

 

 

Provides doctypes to organize the developer's work by the employment of a diary. Take you personal planning and professional records to the next level!

Overview

The Doctypes for Developer Diaries help software developers to plan their working days and weeks besides the work they do with their team.

A diary is typically created in the developer's personal space. The diary is organized in years and days. Once per week the developer may run a personal retrospective.

After you created you diary on a page within a space, add a page for a single year. You may add some strategic plans on this page. For every day of your working life, add a new page. On this page you'll add notes on what you did and especially why you did it and your results and insights. The day of a diary is recorded as a flow of events. While the page create with a Confluence blueprint wizard may seem like a form to fill out, it is not. Typically you add text to the description and links to references or resources section. Adding tags to support finding the information is also optional, but often very handy.

At the end of each day, you may run a retrospective to find things that run well (and therefore should be repeated) and things that run wild (and therefore should be considered as possibility for improvement.

After a work week you may run a retrospective for this week.

 

Please note that every information you add to the diary is optional. This is not meant as a collection of forms to be filled out and passed to your boss.

Instead, this is a personal diary where you note valuable information you want to refer to later:

  • Found some interesting information about a subject? Paste some links and add some notes so that you can come back later and continue!
  • Lost in day-to-day work and lost the whole picture? Try to plan the important topics of your week and then check at the end how far you have come. Try to investigate the problems you have encountered to get your things done. Find a solution: ask yourself, your team members, your agile master!
  • Value your work and get a tool to help you be more business focussed. Make your achievements visible to yourself and let your team mates benefit from you insights and results!

The developer diary is for developers. If you are looking for a basic structure for your team space, please refer to Doctypes for Agile Planning.

 

 

Install Developer Diary for projectdoc!

Get started with your developer diary:

Create a Diary in a Personal Space!

Install additional Doctypes!

Here is an example how the page for a diary year looks like:

Events are organized in day segments. An event is created with a blueprint wizard and is typically the child page of the day page.

The properties demand only a name and a short description.

Add more information to the description section, links go to references or resources.

Attached child documents will automatically show up in "Subordinate Events" or "Attachments".

To get started with your developer diary quickly, please refer to Create a Diary in a Personal Space!

Prerequisites

The projectdoc Developer Diaries requires the projectdoc Toolbox to be installed. The projectdoc Toolbox has a commercial license.

The add-on also uses blueprints from the Core Doctypes for projectdoc (like Role or Stakeholder). This add-on is available on the Atlassian Marketplace for free.

Please install the following add-ons on your Atlassian Confluence server:

1. Install projectdoc Toolbox

List of Doctypes for Software Development

The following doctypes help to run your developer diary.

# Name Short Description Categories
1
Describe your vision for one year. You plan will help you stay focussed to accomplish your goals.
2
Explain an asset of your work. Add this document to a day in your diary.
3
A brief solution to a problem.
4
Categories for cheats.
5
Document the events and insights gained on your working day. This will free your mind from answering adhoc the recurring question of "Where should I add this piece of information?". The diary simply stores information to refine and add it to permanent documentation for later use.
6
The homepage of a developer's daily diary pages. Consider to add your diary to your personal space!
7
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.
8
Take a note on something that has to be done. This is a piece of paper you usually would pin on your monitor. For complex todos consider using an issue tracking system.
9
Describe your vision to focus to get it become real.
10
Document the events and insights gained in your working week. Use it to plan your week and at the end, run a personal retrospective.
11
The developer''s year document is the homepage for the individual days with the diary.

Related Macros

The following macros are provided by this add-on.

Day Rating
Allows a user to select a rating for a day.

Related Topics

Information on developer diaries and related topics for software developers and the projectdoc Toolbox for Confluence.

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.
Track Team Mood
Tracking team mood (or excitement) can be tracked by the use of the Display Table Macro and the Confluence Chart Macro.
Keep a Journal
A practice described in Agile Documentation: In 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.
How to document a Software Development Project
There is no one-size-fits-all for documenting software projects. What we do is giving you an introduction on how to get started with the projectdoc Toolbox and the Software Development Add-on to define your documentation requirements with Confluence.
Hands-on Tutorial
Get started with the projectdoc Toolbox: learning by doing
Use Cases
An overview over the use cases for which the projectdoc Toolbox provides support.

Resources

  • Doctypes - more doctypes for projectdoc.
  • Macros - macros to be used in your doctype templates.