re: Spec organization

Subject: re: Spec organization
From: Sean Hower <hokumhome -at- freehomepage -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 30 Aug 2002 08:58:07 -0700 (PDT)



----------------------------------
Haas, Guy asked:
Do any of you have any architectural suggestions -- things that worked for you? or perhaps horror stories about things that did not work well?
----------------------------------

Organize the files by release. Have the developers put all the materials for a single release in a single folder.

As for the format of the spec, it would probably be convenient for them to put the name of the person making the change, the name of the affected functions (if possible), and maybe estimated time to completion. You could also have them number the changes so that you can track them easier (that's if you're storing your docs in a database).



********************************************
Sean Hower - tech writer
http://hokum.freehomepage.com

"Whatever you do, do NOT let your editorial decisions be made by the squiggly spell-checking lines in Word!" ~Keith Cronin, Techwr-l irritant ;-)

_____________________________________________________________
Create your own web site for FREE at http://www.freehomepage.com

_____________________________________________________________
Promote your group and strengthen ties to your members with email -at- yourgroup -dot- org by Everyone.net http://www.everyone.net/?btn=tag

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Want to support TECHWR-L? Get shirts, bags, hats, clocks,
and more from the TECHWR-L Store. All proceeds support TECHWR-L.
http://www.cafepress.com/cp/store/store.aspx?storeid=techwhirl

Check out the new release of RoboDemo, our easy-to-use tutorial software.
Plus, buy RoboHelp Office in August and save $100 with our mail-in rebate.
Get details and download free trial versions at http://www.ehelp.com/techwr-l

---
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.



Previous by Author: RE: terminology help
Next by Author: tech writer profile - a little OT
Previous by Thread: Spec organization
Next by Thread: Early contracting experiences? Learning the haard way!


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

Sponsored Ads


Sponsored Ads