basforge

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

    RU

    Code, commands and output as text, not as a screenshot

    Give a command, a config or terminal output as a code block, in text: it can be copied, found by search, read on a phone and in dark mode, and edited one line at a time. A screenshot is for when what matters is how an interface looks — and then it’s cropped to the spot that matters.

    Why

    What a screenshot takes away How it ends
    copying the command gets retyped by hand: l for 1, O for 0, a missing space
    search Ctrl+F and site search don’t find the error text, and that’s what people search the page by
    phones a 1600 px wide image on a 360 px screen — letters 4–5 times smaller, and only the whole image can be zoomed
    dark mode a white rectangle on a dark page
    screen readers they read the image’s alt text, if there is any — and nothing more
    editing one changed line means a whole new screenshot; text is edited in an editor

    How to present code

    • Commands and output in separate blocks, or marked to show which is which: people copy the command, not the output with it.
    • Output as an exact copy, with the real error lines: that’s what people search for.
    • A long config with notes on its lines, not an 80-line wall.
    • Replace secrets in output with … before pasting, rather than smudging them in an image.

    When a screenshot is right

    • Where to click in an interface: a panel, settings, the provider console.
    • What the result looks like: a layout, a chart, an error in the browser.

    Even then the screenshot is cropped to the spot that matters, marked with a frame or an arrow, free of anything personal (emails, tokens, URLs in the address bar), and accompanied by the text it was taken for: the button label, the error message.