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.
michqaelangelo jenkins wrote:
>
> I need suggestions on the top 10 questions that one
> would pose to a development team in an efort to
> document multiple interfacing systems.
1) Where is the protocol specification that documents how these
systems interact?
2) Are there other documents, like a design requirements
doc, that are relevant.
3) Is the spec. up to date?
4) Have the customers (or internal users, or marketing dept.)
signed off, agreeing that the spec is what they want?
5) Who else has reviewed the spec.?
6) Are the implementers happy with the spec, confident they
can build to it?
7) Does the implementation match the spec.?
8) How are you testing that?
Methinks the other two relate to that spec as well, but I
cannot think of them offhand.
If (as is all too common) no spec exists, methinks that
needs to be the first doc written.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Take XML and Tech Writing courses online! Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off! http://www.online-learning.com/index.html.
---
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.
