[SeasonOfDocs] Guidance on referring to UI elements in software

Jo Cook jo.k.cook at gmail.com
Fri Jul 19 03:16:30 PDT 2019


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/7fe486d3/attachment.html>


More information about the SeasonOfDocs mailing list