Re: Is this the future of technical writing?

Subject: Re: Is this the future of technical writing?
From: John G <john -at- garisons -dot- com>
To: Julie Stickler <jstickler -at- gmail -dot- com>
Date: Tue, 28 Oct 2014 11:31:05 -0400

As far as Git goes, there is a ton of information - tutorials, quick
references, videos - out there. A lot of it, however, suffers from the same
ills that you mention. Do a search and spend some time looking at the
results and you're likely to come up with some things that might help.

In my own personal experience, I needed to learn how we were using Git in
my company, what the branches were, what our internal procedures were,
etc., and the only people who could provide that were developers on the
teams I support. It was a good bonding experience to shadow a new user and
have them work together with me so that we both eventually grokked it.


On Tue, Oct 28, 2014 at 10:40 AM, Julie Stickler <jstickler -at- gmail -dot- com>
wrote:

> 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
> >
>
>
>
> --
> Julie Stickler
> http://heratech.wordpress.com/
> Blogging about Agile and technical writing
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 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 vwritert -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

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

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:
Is this the future of technical writing?: From: Cardimon, Craig
Re: Is this the future of technical writing?: From: Julie Stickler

Previous by Author: Re: Resources for learning Structured Writing?
Next by Author: Re: Learnin' some git. Was: RE: Is this the future of technical writing?
Previous by Thread: Re: Is this the future of technical writing?
Next by Thread: Re: Is this the future of technical writing?


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

Sponsored Ads


Sponsored Ads