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.
Re: Has anyone ever written the user guide before the product was developed (coded)?
Subject:Re: Has anyone ever written the user guide before the product was developed (coded)? From:Sally Derrick <sjd1201 -at- gmail -dot- com> To:Chantel Brathwaite <brathwaitec -at- castupgrade -dot- com> Date:Wed, 17 Nov 2010 14:48:02 -0600
As long as we're talking about functional specs, does anyone have a good
template doc that you would be willing to share?
Thank you in advance.
Sally
On Thu, Nov 11, 2010 at 3:44 PM, Chantel Brathwaite <
brathwaitec -at- castupgrade -dot- com> wrote:
> Vanessa,
>
> It almost sounds like you'd be writing a functional spec. The functional
> spec often looks a lot like a user's guide, in that it can contain screen
> mockups, steps for performing different functions (which usually comes from
> use case diagrams and maybe sequence diagrams), a full definition of all
> fields in a window as well as the parameters that indicate what range of
> options are acceptable for each field (often comes from other requirement
> documents). Conditions are also in there as well.
>
> Functional specs can often be made end user documentation with very little
> tweaking (provided the developer follows the spec).
>
> This is doable, but works best if you can work closely with the developers.
> That means being part of development meetings and so forth. I personally
> can't see how this would be divorced from the design process frankly, since
> as you write and work through screen mockups, you'll see ways to refine the
> design or find out that other screens etc. are needed to accommodate a
> certain workflow). In a sense, by writing the instructions, you are
> testing
> the idea - and that brings changes. I agree with the others that having
> good software or system requirement specs are key when writing documents in
> this way.
>
> The type of writing that you describe is actually the type that I like best
> because a lot of creativity and collaboration is involved. I've definitely
> written documentation for sections of software that have not been coded,
> including documentation for programmers who said that they were doing to do
> a certain thing - then ended up not doing it - or getting overruled. If
> you
> take this route, be sure to allow time at the end to accommodate the
> changes
> to the software that will inevitably occur.
>
>
> Chantel Brathwaite
> Tech Writer
> Cole Engineering
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Create and publish documentation through multiple channels with
> Doc-To-Help.
> Choose your authoring formats and get any output you may need. Try
> Doc-To-Help, now with MS SharePoint integration, free for 30-days.
>http://www.doctohelp.com
>
> ---
> You are currently subscribed to TECHWR-L as sjd1201 -at- gmail -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/sjd1201%40gmail.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.
>
> Please move off-topic discussions to the Chat list, at:
>http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-