A setup you can find your way back to.

Start with a system map

List the major parts of the setup: operating system, desktop, editor, important services, and configuration locations. Describe what each part does before listing implementation details. Keep secrets and private machine information out of public notes.

Keep a change record

Record the date, relevant version, reason for a change, files affected, expected behavior, and actual result. Link to the documentation used at the time. Do not treat a note about one machine as a universal instruction.

Give commands their context

A command note should explain where it runs, its prerequisites, whether it reads or changes state, and how success is checked. Review commands before running them. A copied command without its context is not a recovery plan.

Write the way back

Record the previous working state and a tested way to restore it. Separate attempted fixes from confirmed results. When the cause is unknown, keep that uncertainty visible rather than presenting the latest attempt as an explanation.

• Use the research-note structure for a troubleshooting record