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.
Subject:Re: Is this the future of technical writing? From:Julie Stickler <jstickler -at- gmail -dot- com> To:"Cardimon, Craig" <ccardimon -at- m-s-g -dot- com> Date:Tue, 28 Oct 2014 10:40:50 -0400
Oh sweet baby Jeebus I hope not. I'm not sure if he's the fellow that
wrote the base Git documentation or not (http://git-scm.com/documentation),
but I can tell you, it's atrocious. I have struggled for the past two
years to learn my way around Git. I have read and re-read their
documentation as I struggled to resolve issues I've had with Git, and as
many times as I've read it, half of it still doesn't make any sense to me
because it's so full of jargon and makes huge assumptions about what the
audience understands. And I don't think it has anything to do with the
fact that I'm a technical writer and not a developer. because many of our
developers and QA engineers seem to have trouble doing more than the basic
functions in Git. We rely a lot on our couple of in-house Git experts to
troubleshoot problems.
Honestly, I don't care what tool chain you used to write your doc, if the
doc that you produce is not helpful to your users, then you've wasted
everyone's time. Yours as a writer, and your audience's as a reader.
On Tue, Oct 28, 2014 at 10:11 AM, Cardimon, Craig <ccardimon -at- m-s-g -dot- com>
wrote:
>
>https://medium.com/@chacon/living-the-future-of-technical-writing-2f368bd0a272
>
>
> Thoughts?
>
>
> Cordially,
>
> Craig Cardimon | Technical Writer
> Marketing Systems Group
> www.m-s-g.com<http://www.m-s-g.com/>
>
>
>
> Information contained in this e-mail transmission is privileged and
> confidential. If you are not the intended recipient of this email, do not
> read, distribute or reproduce this transmission (including any
> attachments). If you have received this e-mail in error, please immediately
> notify the sender by telephone or email reply.
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Read about how Georgia System Operation Corporation improved teamwork,
> communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as jstickler -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
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l
