[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: User Guide Template

Subject: Re: User Guide Template
From: Nina Barzgaran <nina -dot- barzgaran -at- barzgaran -dot- at>
To: Roberta Hennessey <rahennessey -at- gmail -dot- com>
Date: Mon, 11 Oct 2021 17:21:32 +0200

Hello,

I agree with the audience's need as guidance: They are the ones to address - and those that need the guide.

I am sure that SMEs are full of useful information (guessing here, now: ) but they at times tend to overdo it in a kind and friendly manner. ð

The basics are covered to my mind if you *answer the 5 'w's* :

* what?
* (for) whom?
* why?
* ho'w'?
* when? (~ which occasions/use case(s))

Apart from that: Less is more. ð

If you can (time, resources), get beta version feedback from actual users.

And of course they might also provide feedback on their own account via tickets asking for clarification or additional help.

If not already in place, steps in this order may help:
Determine what should go in, *make a structure*, *only then* start to write.

Best wishes
Nina

---

Nina Barzgaran, M.A.
Technical Writer and Communicator

1140 Vienna
Austria

Am 08.10.2021 13:09, schrieb Roberta Hennessey:

I was able to download this user guide templates on Tech Whirlers
https://techwhirl.com/user-guide-template/

And I'd also check out the Write the Docs slack channel.
https://www.writethedocs.org/slack/
Anyone can join.

Let your audience's needs determine your content.
Bobbi

On Fri, Oct 8, 2021 at 4:43 AM Margaret Rosa <margaret -dot- m -dot- rosa -at- gmail -dot- com>
wrote:

I'm working on a user guide for a new application. There is some
discussion on our team as to what should be included in it. I checked the
archives where I saw Connie's template but it no longer seems to
be available.

Could someone point me in the right direction to a template? Or advise
best practice?

For now, it will be either a MS PowerPoint or MS Word document saved to a
PDF.

I appreciate any guidance.

Margaret

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and
content development | https://techwhirl.com

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

You are currently subscribed to TECHWR-L as rahennessey -at- gmail -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com

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

Looking for articles on Technical Communications? Head over to our online
magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public
email archives @ http://techwr-l.com/archives
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com

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

You are currently subscribed to TECHWR-L as nina -dot- barzgaran -at- barzgaran -dot- at -dot-
To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com

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

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.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-leave -at- lists -dot- techwr-l -dot- com


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

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives

References:
User Guide Template: From: Margaret Rosa
Re: User Guide Template: From: Roberta Hennessey

Previous by Author: User Guide Template
Next by Author: Windows 11 - A Few Thoughts...
Previous by Thread: Re: User Guide Template
Next by Thread: Re: User Guide Template

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads