Worklogs¶

Worklogs are dated entries — similar to blog posts — that capture what we did on a given day, what we learned, and what's next. They serve as a running record of development activity, decisions, and reflections.

Why We Keep Worklogs¶

• Transparency: Anyone can follow the project's progress and understand the reasoning behind decisions.
• Continuity: When picking up work after a break, the most recent entry provides context.
• Accountability: Time and effort are tracked in a lightweight, human-readable format.

The Worklog Tool¶

We have been using a worklog pattern across various internal projects for some time — always some variation of a script that creates a dated Markdown file from a template. The pattern works well, but the implementation has been ad-hoc.

A prototype tool lives in this repository at scripts/worklog.py. It reads per-project configuration from worklog.toml and supports different directory structures, section headers, and tags.

The plan is to formalise this into a published Python module (worklog-opsdevnz) so any new project can install it and start logging immediately. Each project gets its own worklog.toml to tailor the template to its needs.