Technical Specifications

Subject: Technical Specifications
From: "James Barrow" <vrfour -at- verizon -dot- net>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 25 Jul 2007 07:31:26 -0700

As you read this, please ignore the squeaky sounds of me scratching my head.

To date, I have been providing the templates, and completing the documents,
for our software project.

The business requirements came and went, and all was good.

I translated those into functional requirements, and all was good.

Now that the Engineering department is ready to go, there's dissention
amongst the ranks regarding the Technical Specifications template.

Donn Le Vie wrote a great article and I fashioned my template using this as
a guideline:

http://www.techwr-l.com/techwhirl/magazine/writing/softwarerequirementspecs.
html

The developers didn't like it because it was too detailed. Too detailed.
Like vague and ambiguous is the better way to go.

I'm looking at this but, in my opinion, it is at too high a level to explain
to developers what to build into the application:

http://www.computing.dcu.ie/~roconnor/modules/ca326/tmanual.html

If anyone has a tried-and-true template or method, I'd appreciate it.

Thanks,

Jim

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.


Previous by Author: RE: PM Woe
Next by Author: RE: Priority #1 (maybe)
Previous by Thread: RE: The coming predominance of user experienceandtechnicalcommunications
Next by Thread: Re: Technical Specifications


What this post helpful? Share it with friends and colleagues:


Sponsored Ads