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.
Depending on the product, you may find that test documents may also be
important (that is, documents that describe tests to be performed on a
product or system, and documents giving the results of these tests).
In telecom, many systems are expected to comply with certain standards.
Tests show whether they do or not. Test documents show customers that
your system does what it was designed to do.
HTH,
Martin Polley
martinp -at- surf-com -dot- com
Surf Communication Solutions
www.surf-com.com
Tavor Building
tel +972 (4) 9095732
PO Box 343
fax +972 (4) 9594055
Yokne'am 20692
mobile +972 (53) 864280
Israel
ICQ 15617901
-----Original Message-----
From: Shea Michael EXT [mailto:Michael -dot- Shea -dot- extern -at- icn -dot- siemens -dot- de]
Sent: Monday, October 14, 2002 9:46 AM
To: TECHWR-L
Subject: RE: Hardware Documentation
Neysa,
The kind of documents you need are dependent on the needs of your
customer. I am currently documenting telecommunication equipment. The
kinds of things that need to be decribed are as follows:
How do I physically install it.
How do I get it running.
How do I install and operate the management software.
How do I maintain the equipment and troubleshoot problems.
What are the features of the system and what do they mean or how does it
fit in the big picture.
That is what is required by my customer. Whether it meets your
customer's needs is another question. You may notice that really these
are the same kinds of questions you answer when you document software.
How do I install it.
What do I do with it.
How do I get it to do what I want.
What do I do when things go wrong.
MILspec is only necessary for the military or if that is what your
customer prefers. It isn't required by the telecom business, nor the
semiconductor business; the other hardware writing that I have done.
As a side note, your customer is really choosing a bad time to try and
break in to the telecom business. The news is full of telecom companies
laying off workers by the thousands and tens of thousands.
Michael Shea
XpressLink Documentation
c/o ICN AS BA ST2
--------------------------------------------------------------------
Michael Shea
ROSEMANN & LAURIDSEN GMBH
Am Schlossberg 14, D-82547 Eurasburg, Germany
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at http://www.ehelp.com/techwr-l
Buy ComponentOne Doc-To-Help 6.0, the most powerful SINGLE SOURCE HELP
AUTHORING TOOL for MS Word. SAVE $100 on the full version and $50 on the
upgrade. Offer ends 10/31/2002 (code: DTH102250). http://www.componentone.com/d2hlist1002
---
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.
