I usually work as a lone TW on a project team, and I do the following for
myself and tidy it up so another person can use it.
- a style sheet that is well annotated.
- a glossary is always very popular with everyone on the project, so that
goes into a public folder, or a webpage on the intranet.
- the standard phrases and unusual layout. This maybe the weird dot point
lists that some people prefer, and always my own numbered list style.
- if I make templates for general use, they have plenty of notes and tips
within them. I gave a paper on this at the ASTC conference back in 1995
(about).
- often, the analysts and programmers have little idea where to start when
writing, so these notes are a great help to them. They also make it easier
for me to edit and tidy up their writings.
- directions from the project manager, web master and so on that arrive
within emails and minutes of meetings, are cut-and-pasted and collected in
a sub-folder. The technical term for this is, I think, ‘covering your
arse’. It also helps when a new manager asks “Why are you doing this all
wrong?”
Teams
If I am working in a team, we do all of the above -- after a lot of
discussion.
We also share macros, GIFs, and images and whatever.
This is always kept in a sub-folder of our main folder, obviously.
Web pages
When writing webpages, I usually write a comment at the very end of the
HTML. As needed, I write comments in the body of the code.
Sometimes, there is an area in the HTML code where all contributors note
what changes they just made, and date it. It is either at the top, just
after the title block, or at the very end. This standard practice for
computer code.
Bob T
On 11 February 2017 at 14:18, Janet Taylor <janet.taylor@xxxxxxxxxxxx>
wrote:
I always write up job tasks and for the past 12 months, have been using
the procedure format recommended by Rosemary O'Donohue at the 2016 ASTC
conference. I use words (and screen captures), not video, as that is easier
for me to review and re-use.
Luckily I have two TWs working with me, one in Japan and the other in
Finland, so I'm forced to do the write-ups but I've always believed in
leaving a 'legacy' notes so as not to waste my effort doing a particular
job.
Regarding the actual instructions:
When I describe using particular software (in my case Flare) I assume
limited knowledge because, while someone might be familiar with that
software, they may not be familiar with the way I use it. I assume that
they can start it, and manoeuvre to a particular point in the software.
I also assume that any potential reader can write as required and use
Word. They won't know what folders I might keep certain files in (e.g.
template backups) and in some cases, the logic of my file structure, so I
always document that.
In my case, I have many part time non-TW authors who may not be in
Australia. For them, on a networked server, I have created a file of
instructions for changing Word settings when they touch my documents (most
turning everything 'auto' off). Getting them to look that up has had
limited success but as most have English as a second language, I've also
included how to use certain words (e.g. its and it's). That's an attraction
for them as they really do try not to make mistakes. It also includes
instructions that I use, such as the format for links that have specific
outcomes.
As I work as a lone TW, I always have the thought in my mind "what would
happen if I couldn't work for some considerable time commencing tomorrow".
It might sound time consuming, but isn't once you get started.
I hope that helps.
-----Original Message-----
From: austechwriter-bounce@xxxxxxxxxxxxx [mailto:austechwriter-bounce@
freelists.org] On Behalf Of Xmplar
Sent: Friday, 10 February 2017 11:08 PM
To: austechwriter@xxxxxxxxxxxxx
Subject: atw: Have you documented your tech writing tasks?
I'm in the middle of having to write up what I do as a tech writer -
"internal documentation" - as well as writing customer-facing doco, and
wondering who has been faced with a similar situation.
Have you been asked to write up what you do in your job, or do you
voluntarily write notes on what you do as a tech writer for your
organisation?
Are they rough notes (for the next person, who it's assumed knows about
tech writing) or do you meticulously organise job procedures assuming that
the next person who picks up your job is a beginner?
Do you always write up job tasks, or is video/screen captures easier?
**************************************************
To view the austechwriter archives, go to www.freelists.org/archives/
austechwriter
To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx
with "unsubscribe" in the Subject field (without quotes).
To manage your subscription (e.g., set and unset DIGEST and VACATION
modes) go to www.freelists.org/list/austechwriter
To contact the list administrator, send a message to austechwriter-admins@
freelists.org
**************************************************
