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.
"If you are able to fill out a bug report that actually identifies the code that causes an UI glitch you found while writing the user manual, you will be golden."
I do something like this all the time. I don't have access to the code, but I message the developers with enough description so they can find what they need to find.
Craig
-----Original Message-----
From: techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com <techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com> On Behalf Of Gene Kim-Eng
Sent: Monday, February 24, 2020 12:42 PM
To: Emoto <emoto1 -at- gmail -dot- com>; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Job Description - Thoughts?
If that approach succeeds, I blame the tech writer who takes the job for a "tech writer salary" that isn't equal to that of a developer.
By the time most startups even think about hiring a tech writer, the bulk of their development work has already been done. What they're hoping for is a writer who has enough experience and knowledge on the technical end to be able to generate usable instructions from nothing but an alpha or beta build and the code comments without having to be spoon fed input from developers who are frantically trying to find and fix as many of the remaining bugs that they can in time for release.
If you are able to fill out a bug report that actually identifies the code that causes an UI glitch you found while writing the user manual, you will be golden.
Gene Kim-Eng
On 2/24/2020 4:43 AM, Emoto wrote:
> As I think about this listing, especially in the context of it being
> astart-up (do we hyphenate that?), my cynical side wonders if
> maybethey really want someone to do all the API and Network work who
> willalso write it up, and that they approach it from the tech writer
> sideto keep costs down. :-/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com
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
