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: Quality of source material from Development From:Iggy <iggy_1996dp -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 12 Dec 2001 16:14:37 -0800 (PST)
Isn't this what design and functional specifications
are for? To communicate how the application should be
built (which includes syntax in output/commands)? I
don't understand why you'd need developers to spoon
feed you syntax when it could be determined by knowing
what your product does, how it is constructed, and
what protocols it follows...
> Your situation is exactly what my friend is trying
> to get started --
> developers provide and maintain a spreadsheet that
> lists the command syntax,
> description, and other technical reference material.
> The tech writers can
> refer to this spreadsheet when writing and
> maintaining customer documents.
> Other posts indicate this situation is rare.
> But thanks for letting me know it actually does
> occur elsewhere.
__________________________________________________
Do You Yahoo!?
Check out Yahoo! Shopping and Yahoo! Auctions for all of
your unique holiday gifts! Buy at http://shopping.yahoo.com
or bid at http://auctions.yahoo.com
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
---
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.