Tech Writing: Documenting icons that occur multiple times on one screen
Hi,
I'm documenting a screen that has 7 graphs/charts. While the format differs, they all have the same two icons
- Export Data (Download icon)
- Change View (TV set icon)
I'm thinking it would be redundant to repeat the same explanations for all 7 graphs/charts. Especially if functionality changes (e.g., Export becomes Export/Import). Accordingly, I'm considering having a short section at the top called Global Commands.
Pro: Cleaner b/c you have only one instance of these explanations.
Con: If user is on the section for, say, the 4th metric, he may not know to scroll up to the top of the document.
Or - maybe a compromise. In each section, have a link "Click here for additional commands", where here links to the global command section.
What do you all think?
Thanks,
Steve
ASKER CERTIFIED SOLUTION
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
ASKER
Follow-up:
Wondering if I am using the correct terminology. If a command exists on 7 panels within a screen, is global the right word to use? To me, it would apply more to a single command that affects all 7 panels. If global isn't appropriate for my case, what would be?
Thanks.
Wondering if I am using the correct terminology. If a command exists on 7 panels within a screen, is global the right word to use? To me, it would apply more to a single command that affects all 7 panels. If global isn't appropriate for my case, what would be?
Thanks.
i utilise "common" rather than global.... but im in the infrastructure space... and depending on your area - and even part of the world - i imagine there would be different thoughts on this.
ASKER
Thank you for your help. Good to get some confirmation on my proposed solution.
ASKER
Exactly. I'm probably going with the link to the global commands section. Thanks for your input.