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.
Not sure how current the content is in terms of 'best practice.' It looks a
bit dated.
Are you writing functional specs., as in, "the system will do this, that, or
the other thing...."?
It doesn't sound like you are writing detailed (code level) designs.
Tom
>
> I have been given the task of writing a high-level System Spec for our
small
> company. This will be a new journey for me, as I've never written a spec
> before, but I'm actually looking forward to the experience (sort of).
>
> I have many questions, and would appreciate any help or suggestions.
>
> What kind of information goes into a "high-level" spec?
>
> Can anyone recommend a good template or resources on writing a system
spec?
>
> TIA,
>
> Lisa
>
>
Buy or upgrade to RoboHelp X3 today and receive the WebHelp
Merge Module for FREE ($299 value). RoboHelp X3's all-new
features include conditional text, completely re-engineered
printed documentation output, Context-sensitive Help Toolkit,
single-source layouts, and more!
Order online today 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.