TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
>#37 on my list of TW dislikes: documenting from screen captures instead
>of the actual app.
I should clarify. I am editing a Quick-start Guide that was derived from the User's Guide. I didn't write either and don't have access to the software. I don't know if the software was available to the writer of the original documents.
Reviewers have added a detail to the Quick-start Guide; the topic is described in full in the User's Guide, and they want a cross-reference to the UG. I agree. Therefore, I need to make a cross-reference to a particular screen that is documented in the User's Guide. My original question was about what to call (in a cross-reference) a window that had a main title, which remained consistent over several windows, and a subtitle, which was unique.
The passages in the UG don't need to refer to the screen shots by title because the text and figures flow smoothly together, so that writer never referred to the window titles. So, I have to, for the window that is the target of the cross-ref.
By the way, I went with the format several people suggested, Main Title - colon - Subtitle, as in "Hardware Setup:Plugging In the Toaster."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
