[SeasonOfDocs] Guidance on referring to UI elements in software

[Jared Morgan]

https://docs.microsoft.com/en-us/style-guide/procedures-instructions/describing-interactions-with-ui is a popular resource on Write the Docs. 

Sent from Mail for Windows 10

From: Jo Cook
Sent: Friday, 19 July 2019 8:17 PM
To: seasonofdocs at lists.osgeo.org
Subject: [SeasonOfDocs] Guidance on referring to UI elements in software

Hi All,

Does anyone know where I can find some good guidance on referring to UI elements in software when writing documentation?

For example, is "click the sign-in link" self-explanatory enough in the context of a beginner's guide to using a web application or is there a clearer way of describing this action? I'm always conscious of the language we use when referring to interacting with the computer when I help out relatives- they don't necessarily understand that "click the button" means "move the mouse cursor until it's over the button icon on the web page and then press the left button on your mouse", but is it OK to assume slightly more familiarity when writing beginners guides to software?

Thanks

Jo

-- 
------------------------
http://about.me/jocook

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/seasonofdocs/attachments/20190719/ece64f5e/attachment.html>