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.
I'm working on a manual that describes the reports generated by the application. The reports are provided in either Excel or PDF format, and indeed each report is titled "Something Blah Blah Report."
Therefore, formally, the title always includes the term "Report," which then gets repeated ad nauseam throughout the document. Example:
Chapter 7: Pie-Baking Reports
There are five types of pie-baking reports:
---Apple Pie Report
---Cinnamon Streudel Report
---Pizza Pie Report
---Clam Pie Report
---Rocks 'n' Stuff Report
Then, each subsection has the title of the report, including the word "Report," and the first sentence of each section inevitably repeats the report name, including the capitalized word "Report."
Is it acceptable to drop "Report" from the initial bulleted list and the title of each subsection, and lowercase it in the text where it does occur? Just to give the reader a break? , So, the example would say,
There are five types of pie-baking reports:
---Apple Pie
---Cinnamon Streudel
etc., etc.
Or should I stick with the strictly accurate -- after all, no one is going to read this document like a novel, so presumably no one will get sick of reading the word over and over. Maybe I am aware of the repetition only because I'm working on the doc.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-