Re: Coding documentation?

Subject: Re: Coding documentation?
From: Haim Roman <haim -dot- roman -at- gmail -dot- com>
To: Hannah Drake <hannah -at- formulatrix -dot- com>
Date: Wed, 4 Dec 2013 21:38:54 +0200

If this documentation about your company's products, then maybe relate a
doc's part # to the part # of the product it documents, or the part # of
the main component of the product.

If it's documentation from external sources, do they have ISBNs?

-- Howard (Haim) Roman



On Wed, Dec 4, 2013 at 9:17 PM, Hannah Drake <hannah -at- formulatrix -dot- com> wrote:

> Hi TechWrl Family,
>
> (I'm loving this list by the way) -- Now that my company has started to
> grow a library of professional documentation, someone suggested assigning
> part numbers to the documentation instead of just the date it was released.
> But, the convention they use for our part numbers doesn't quite work for
> documentation.
>
> What numbering conventions can you suggest? Right now I just keep the
> latest version of something on our Google wiki, which has a version
> history, so that sort of works. But I feel like it would look more polished
> if we started using some fancy, "no idea what that number means --
> QT75729A2 is so mysterious" numbering system.
>
> --
> Hannah L. Drake
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 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 haim -dot- roman -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
>


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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


References:
Coding documentation?: From: Hannah Drake

Previous by Author: Safe handling, was RE: Creative Labeling
Next by Author: Re: Hosted Help - server specs?
Previous by Thread: RE: [BULK] Re: Coding documentation?
Next by Thread: Re: Coding documentation?


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

Sponsored Ads


Sponsored Ads