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.
Nuzhath Shereen reports: <<Iam new to this mailing list. I'm not sure if
this list has discussions on basic concepts.>>
Just about any topic is fair game, provided it relates to technical
communication. That's particularly true if you've looked through the
archives (http://www.raycomm.com/techwhirl/archives/archives.html) and
haven't found an answer to your question.
<<I would like to know if we can put a tip or a note between 2 sentences of
a numbered list? For example:...
2. do this
tip: .....
3. do that
Is the above format okay? or should we put the tip at the end of the list.
But the tip here is relevant only to item 2?>>
Your format is fine, provided that readers do not require the tip before
they can successfully do step 2. Such tips, including warnings, should
always come _before_ the step they describe so readers have a chance to
understand the potential problems before they try to perform the step. If
the tip describes the best way to do step 2, it should come before step 2;
if it only explains something the reader should consider _after_ they've
done step 2, then it's current position is fine. (A good example might be:
2. Save the file. Tip: make a backup copy now in case your computer
crashes.)
--Geoff Hart, geoff-h -at- mtl -dot- feric -dot- ca
Forest Engineering Research Institute of Canada
580 boul. St-Jean
Pointe-Claire, Que., H9R 3J9 Canada
"Writing, in a way, is listening to the others' language and reading with
the others' eyes."--Trinh T. Minh-Ha, "Woman native other"
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr
Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
