TEK / working context

Working notes / tek-services.com

Context belongs with the work.

TEK / working context is an editorial resource about making technical work easier to understand and continue.

What the pages cover

The subject is the hand-off: the note that explains why a task exists, what is currently known and what the next reader needs to investigate. The same writing questions can be useful in an issue, a review note or a project document.

The pages focus on communication rather than promoting a product or offering a technical service. They do not need a particular tool, process or organisation to be useful.

Why observations and explanations are separate

An observation records what was encountered under stated conditions. An explanation proposes why it happened. Both may belong in a working note, but the reader needs to know which is which.

The distinction helps a colleague decide what can be taken forward and what still needs checking. It also makes it easier to update a note when a proposed explanation changes.

The role of a constructed example

The overview uses a simple interface question about filter state. It is an illustrative scenario, chosen to make purpose, scope and uncertainty concrete without depending on a real project.

The example does not supply a diagnosis of a particular codebase. Its useful part is the shape of the note: the context that lets another person begin an informed investigation.

How to use the resource

Start with the hand-off guide when you have scattered notes to organise. Start with the overview when you want to see the structure in a compact example.

Use the headings in whatever writing environment fits the work. A context packet is a set of useful distinctions, not a required template.

Return to the overview →