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.
Subject:Re: Titles of forms and reports in text From:Craig Haiss <craighaiss -at- yahoo -dot- com> To:Pamela Ovington <POvington -at- prosperacreditunion -dot- ca>, techwr-l -at- lists -dot- techwr-l -dot- com Date:Wed, 11 Jan 2006 09:57:31 -0800 (PST)
I would definitely use either quotes or some other formatting (bold, italic, etc.) to separate the names from the surrounding text, especially if the titles are very long. Otherwise your sentences can become very confusing. Perhaps the hyperlink alone is enough to set them apart, if you make it a convention to hyperlink all of them.
I don't think it matters what type of formatting you use as long as you are consistent.
----- Original Message ----
From: Pamela Ovington <POvington -at- prosperacreditunion -dot- ca>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Sent: Wednesday, January 11, 2006 12:39:13 PM
Subject: Titles of forms and reports in text
Hello Techwhirlers,
Would you enclose titles of internal documents, such as forms or
reports, in quotation marks when you refer to these titles in text? For
example, 'When you complete the "Clearing Items" report, send it to head
office.' Such references often hyperlink to the form or report itself,
but not always. I assume that you treat such titles as you would titles
of magazine articles.
I would appreciate your comments.
Pamela Ovington
Technical Writer
Prospera Credit Union
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to TECHWR-L as craighaiss -at- yahoo -dot- com -dot-
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
