basforge

Search titles, text and the “If it doesn’t work” cases.

    RU

    A heading says what’s inside: “Where the backups live”, not “General information”

    A section heading names its point: an answer, an action or the reader’s question. Read in a row, the headings are the page’s plan; if they don’t tell you where things are, “layer cake” scanning won’t work.

    Why

    The fastest way to scan a page is by its headings: the gaze jumps from one to the next and reads the text under the one that fits (NN/g, 2019). That works only if the heading says what’s under it. “Description”, “Setup”, “Other” fit any page — so they help find things on none.

    What it looks like

    Empty Says what’s inside
    Introduction What problem Traefik solves
    General information Where the backups live and how long they’re kept
    Setup Key-only login: three lines in sshd_config
    Notes If the backup won’t restore
    Troubleshooting 502 Bad Gateway after an update
    Conclusion — the section isn’t needed (Answer first)

    Fixed headings that people look for by eye are the exception: “If it doesn’t work” and “How to check” appear on every page of this site, and the reader knows what’s under them.

    The check

    Write out the headings in a row — in the browser console it’s one command (Checking presentation). If you get a plan that answers “where’s the part about X?”, the headings work.