Independent resource / systemctrl.com
The state and feedback record.
A practical sequence for describing one action, its signals and the conclusions they can support.
1. Name the intended outcome
Write what someone wants to make possible. Keep it separate from an implementation or an action already suggested.
The outcome gives the observation a useful question.
2. Identify the request
Record the instruction and how its receipt is acknowledged.
Do not treat an acknowledgement as evidence of completion unless it actually establishes that result.
3. Trace the signal
Identify the source of each important label or display. Keep the context of the observation.
A familiar word should not replace an explanation of what it means.
4. Describe the states
Use labels that distinguish requested, pending, established and unresolved conditions where relevant.
Agree the actual vocabulary with the people responsible for the system.
5. Examine alternative paths
Consider a delayed, interrupted or incomplete result in relation to the intended outcome.
Keep uncertainty visible rather than placing every response under the same success label.
6. Review the reader’s conclusion
Ask what someone can reasonably infer from the feedback. Connect that reading to the evidence.
If the label implies more than the source establishes, identify the distinction that needs clarification.
7. Keep the next decision
Record what was established and which question remains. Name the next source or responsible person.
A useful technical note leaves both the meaning and its limit understandable.