/manuals/how-i-write-manuals-here

How I write manuals here (template & cheat sheet)

The structure I use for every manual on this site, plus a quick reference for code blocks, callouts and tables.

  • meta
  • astro

This is both the first manual on the site and the template for all the others. Every manual here follows roughly the same shape: what problem it solves, what you need before starting, the steps, and the gotchas I hit along the way.

What you’ll need

  • A problem worth documenting
  • The commands or clicks that actually solved it
  • Five minutes to write it down before you forget

Steps

1. State the goal

One or two sentences: what will work at the end that didn’t work before.

2. Show the commands

Always mention the shell or tool:

# Connect to Microsoft Graph with the scopes you need
Connect-MgGraph -Scopes "DeviceManagementManagedDevices.Read.All"
Get-MgDeviceManagementManagedDevice -Top 10
# The Linux equivalent of "have you tried turning it off and on again"
systemctl restart the-thing.service
journalctl -u the-thing.service -f

3. Call out the gotchas

Warning! This is what a callout looks like — use it for the step everyone gets wrong the first time.

There’s also a plain variant for good-to-know context that won’t break anything.

4. Summarize the settings

Tables work well for configuration reference:

Setting Value Why
Assignment Required Users forget optional things exist
Restart grace time 120 min Lunch-break friendly
Scope Pilot group Test on people who forgive you

Troubleshooting

End with the errors you actually saw and what fixed them. That’s the part search engines — and desperate admins at 2 a.m. — care about most.

← all manuals