How to keep dev notes and retros in your diary

A habit of noting what you worked on, what got stuck and what you learned — and how code formatting and the work templates fit in.

2 min read · Updated

When you work, you keep asking “how did I fix that last time?” A few lines at the end of the day answer that. You open your diary every day anyway, so you do not need a separate dev log.

Five minutes at the end of the day, four headings

The Dev notes template has four headings: what I worked on, what got stuck, what I found out and next steps. Just writing down what got stuck decides where tomorrow starts. One line is enough for what you found out.

When you meet a bug

The Bug and issue log template runs through the symptom, steps to make it happen, what should happen, what happens instead, the likely cause and the fix. Keep it after the fix: when the same symptom comes back, the fastest place to look is your own diary.

Code in code formatting

While writing, press [Code] (</>) on the format bar or Ctrl+E, or type /code at the start of a line, and what you write next goes in a fixed-width font. Press Enter with it on and the next line is code too, so several lines form one block. Indentation stays as you typed it.

When you export as Markdown, code becomes a ``` block, so it keeps its shape in other document tools.

Do not paste passwords, API keys or tokens into a code snippet. The diary is encrypted, but once you export it or share your screen it shows as it is. For company code, check your company’s rules first.

Collecting what you learned: Today I learned

The Today I learned template has three headings: what I learned, where I learned it and what to look into. There is a short frame too, so a busy day is no burden. After a year, Year in review shows which tags you used most.

Closing a week: Weekly work summary

On Friday, note what you did this week, what is in progress, what is blocked and the help you need, and next week’s work, and on Monday morning you know where to start. The existing Daily review (KPT) template — keep, problem, try — suits a dev retro too.

Other work and docs templates

You can swap templates even over what you wrote and set a default for new entries. Preview them all in the template gallery.

‹ All guides

Get NightInk

Choose the store for your device.