Re: Coding documentation?

Subject: Re: Coding documentation?
From: Hannah Drake <hannah -at- formulatrix -dot- com>
To: Milan Davidović <milan -dot- lists -at- gmail -dot- com>
Date: Wed, 4 Dec 2013 15:06:07 -0500

Yes -- so our "convention" is/was simply sequential -- e.g. "206250" which
didn't mean anything in and of itself. It the part was revised, they added
"206250_A" and kept going with the letters for each revision. Apparently
they are attempting to come up with a new numbering system now, forced
because of some software they're migrating to.

The reason I don't like it, is because I would prefer to use a convention
that actually means something. One of our support techs is also a car
hobbyist and pointed out that car part manuals (at least some) have a very
well thought-out convention, so if you knew the convention you could look
at a part number and have an idea of what it was.

Also, I'm not sure how they would log documentation as a part number in
SolidWorks, and I'd be afraid of screwing up the part number system in
their software by adopting their system and "stealing" some numbers.


On Wed, Dec 4, 2013 at 2:56 PM, Milan DavidoviÄ <milan -dot- lists -at- gmail -dot- com>wrote:

> On Wed, Dec 4, 2013 at 2:17 PM, Hannah Drake <hannah -at- formulatrix -dot- com>
> wrote:
> > But, the convention they use for our part numbers doesn't quite work for
> > documentation.
>
> Can you elaborate?
>
> --Milan DavidoviÄ
>
> Sent from my Commercial Visible 6
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> New! Doc-to-Help 2013 features the industry's first HTML5 editor for
> authoring.
>
> Learn more: http://bit.ly/ZeOZeQ
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as hannah -dot- drake -at- formulatrix -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
>



--
Hannah L. Drake
Lead Technical Documentation Specialist
Formulatrix, Inc.

781-788-0228 x137 (office)
617-610-6456 (cell)
hannah.drake.formulatrix (skype)


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

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

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


Follow-Ups:

References:
Coding documentation?: From: Hannah Drake
Re: Coding documentation?: From: Milan Davidović

Previous by Author: Re: Coding documentation?
Next by Author: Re: Hosted Help - server specs?
Previous by Thread: Re: Coding documentation?
Next by Thread: Re: Coding documentation?


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

Sponsored Ads


Sponsored Ads