Comments on: “Could you please tell me what the job of a technical writer is like?”

By: Technical Writing–Seven Challenges : Freelance Writing Jobs | A Freelance Writing Community and Freelance Writing Jobs Resource

Fri, 26 Mar 2010 12:31:33 +0000

[...] “Could you please tell me what the job of a technical writer is like?” from Tom Johnson [...]

By: Paul Sholar

Paul Sholar — Fri, 17 Apr 2009 04:32:57 +0000

Another way to keep track of what’s changing in a software product that’s under development is to follow the log of changes being checked into the product’s source code repository. Assuming that the software developers are required both to comment their source code (let’s please hope so) and to enter audit-supportive descriptions of each change checked into the repository, the curious writer who isn’t put off by inspecting the change logs (and perhaps also the product’s source code) can keep track of what’s changed in the product in a comprehensive and reliable manner.

Sometimes a built-in limitation or assumption found in the product’s code has been changed that would lead to a change in the documents; giving the writer notice of these kinds of changes is often overlooked by the developers.

Watching check-ins to the source code repository might be necessary if (1) the developers tend not to disclose what they’re doing outside of their own teams, (2) the product’s “hidden” features are important to be documented, (3) the product’s user interface is so rich that keeping track of how it’s being changed is impossible by inspection alone.

By: zibex

zibex — Wed, 21 Jan 2009 20:08:47 +0000

HW2GQK hi! nice site!

By: Make your own Website

Make your own Website — Mon, 18 Aug 2008 16:24:15 +0000

I too used to be a marketing copywriter and played with the idea of becoming a technical writer. Even applied for a few jobs. Boy after reading your post am I glad I didn’t – I am just not the right sort of person for the job. It actually amazes me that you could deal with all of that day in day out. Hats off to you cause without technical writers the tech world would grind to a halt.

By: Being a Technical Writer in Shanghai/China | Shanghai Tech Writer

Being a Technical Writer in Shanghai/China | Shanghai Tech Writer — Tue, 06 May 2008 13:28:34 +0000

[...] day as a technical writer. I’ve read about the typical day of a technical writer from the U.S., Australia, the U.K., and . . . China (me)! Despite the fact that we live in different parts of the [...]

By: Typical Day | Shanghai Tech Writer

Typical Day | Shanghai Tech Writer — Sat, 26 Apr 2008 04:13:45 +0000

[...] I’d Rather Be Writing blogger wrote a great article about a typical day as a technical writer. I was going to blog about [...]

By: Typical Day as a Technical Writer at NI Shanghai | Shanghai Tech Writer

Typical Day as a Technical Writer at NI Shanghai | Shanghai Tech Writer — Sat, 26 Apr 2008 03:55:25 +0000

[...] day as a technical writer. I was writing about another blogger/technical writer I read about and his typical day. But since then, my post always shows up on the first page result when googling “technical [...]

By: Tech writer's spot: Typical day

Tech writer's spot: Typical day — Tue, 22 Apr 2008 10:03:05 +0000

[...] at work. Well, although the descriptions are typical, they’re by no means similar! See for yourself:A writer’s typical day in the USA.A writer’s typical day in China.A writer’s typical day in the UK.A writer’s typical day in [...]

By: Tom

Tom — Sat, 29 Mar 2008 18:29:25 +0000

I updated my post with a direct link to your post. Thanks for letting me know about it.

By: Susan

Susan — Sat, 29 Mar 2008 08:33:23 +0000

Hi Tom! I love reading your blog. Your post inspired me to write about my typical day at NI Shanghai. http://www.blindmansfaith.com/NISH/2008/03/29/typical-day-as-a-technical-writer-at-ni-shanghai/