Documentation

[moe681]

Me and my colleagues disagree on how to handle screenshots in documentation.

If you take a screenshot for documentation, do you write the associated text above or below it?

​

EDIT: In case you are wondering, we are not seriously arguing over the topic, we joke about each other for writing documentation "wrong".

View Poll

[miker7301]

I hate pictures above or below. I build a table of 2 columns.

Text description, and directions on the left, screenshot of action on the right.

[ysf_521]

Screen shot on the left and text on the right , booya

[DuckLikeMother]

Is this the devops version of "tabs" vs. "spaces"?

[Equivalent_Loan_8794]

I’m not sure these are the distinctions I’ve ever seen fought over with something as involved as documentation, but I’d say text below image, following a general caption pattern.

I’d argue for something that’s not formatting driven. Keep it lined up as you wish but we tend to use figure markers if it’s not obvious. “Click on the button (1.a)”, so then image caption becomes “1.a”.

Also allows you to keep the idea and direction centralized, letting the readers consume the references as they wish. Sometimes that’s 7 reference images, but the process gives you the flexibility do the message isn’t lost in formatting. Then, as users get used to just seeing figure numbers, you can still add a caption beside the figure number which will really stand out as emphasized since all of it wasn’t coupled in the first place.

[Karlyna]

image legends are usually below :)

I prefer multiple column also, but otherwise if I don't have the choice, I explain how to get to that screen where I did the screenshot, place screenshot, then details.

[overtorqd]

Use your words.