Re: Website Documentation Procedures - Educating an Employer

[voxwoman <voxwoman -at- gmail -dot- com>]

Also take a look at Jakon Nielsen's web usability website:
http://www.useit.com/
-Wendy

On Fri, Aug 29, 2008 at 5:13 PM, Collin Turner
<straylightsghost -at- gmail -dot- com>wrote:

> What I'm asking for is this (guess I could have explained this a bit
> better,
> eh?)
>
> If someone was going to come to me tomorrow and say "Collin, we need you to
> document this web portal we're thinking of building, what is the SOP for
> creating user docs for said portal?"
>
> What is a good source of info I can point them to?
>
> Yes, I know the SOP. I've done it many, many times. However, as we all
> know,
> sometimes an outside viewpoint is better than "me" with a large bit of
> trout. It would be helpful to have an Industry standard doc pointing to
> when
> in and at what stages it's safe to start actually writing the details of
> UI,
> functionality, etc.
>
> As I stated, the developers are in India and I haven't had a whisper of
> this
> until yesterday...and it launches Oct. 1.
>
> And it's not even being tested yet.
>
> Hehehe...this is Not a software company. They aren't familiar with this
> type
> of thing (don't even have a wireframe...poor souls).
>
> -Collin
>
>
>
> On Fri, Aug 29, 2008 at 3:03 PM, Bonnie Granat <bgranat -at- granatedit -dot- com
> >wrote:
>
> > Are you talking about development documentation (for people who work on
> the
> > website) or user documentation (for people who use the website)?
> >
> > If the former, a doc plan should precede creation of a website. If the
> > latter, follow the plans in the doc plan. If the former, create a doc
> plan
> > now that corresponds to the site.
> >
> >
> > Bonnie Granat
> > http://www.GranatEdit.com
> >
> >
> > > -----Original Message-----
> > > From:
> > > techwr-l-bounces+bgranat=granatedit -dot- com -at- lists -dot- techwr-l -dot- com
> > > [mailto:techwr-l-bounces+bgranat <techwr-l-bounces%2Bbgranat><techwr-l-bounces%2Bbgranat>=
> > granatedit -dot- com -at- lists -dot- techwr-l
> > > .com] On Behalf Of Collin Turner
> > > Sent: Friday, August 29, 2008 12:21 PM
> > > To: techwr-l -at- lists -dot- techwr-l -dot- com
> > > Subject: Website Documentation Procedures - Educating an Employer
> > >
> > > Not that I hope to change anything...
> > >
> > > I need to provide some solid 3rd party (preferably
> > > "official") documentation
> > > procedures for providing documentation for websites.
> > > Specifically pre-launch
> > > - at what point during the Dev cycle should the documentation
> > > be created,
> > > reviewed, etc. Standard procedure for the Industry.
> > >
> > > Anybody have some useful sources?
> > >
> > > Thanks!
> > >
> > >
> >
> >
> >
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> ComponentOne Doc-To-Help gives you everything you need to author and
> publish quality Help, Web, and print content. Perfect for technical
> authors, developers, and policy writers. Download a FREE trial.
> http://www.componentone.com/DocToHelp/
>
> 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 voxwoman -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/voxwoman%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.
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ComponentOne Doc-To-Help gives you everything you need to author and 
publish quality Help, Web, and print content. Perfect for technical 
authors, developers, and policy writers. Download a FREE trial.
http://www.componentone.com/DocToHelp/

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.