Previous in Forum: Muntain Pine Beetle   Next in Forum: Help about Martrix Converter
Close
Close
Close
19 comments
Rate Comments: Nested
Associate

Join Date: Sep 2007
Posts: 49
Good Answers: 1

ENGINEERING DOCUMENT CODING

04/26/2008 1:26 AM

Dear Friends

I want to plan a document numbering system for my company projects.

In this system each type of documents and drawings will be defined by a three-letter or two-letter code. For example SP or SPC for Specifications and DS or DSH for Data sheets and CAL for Calculations. Could any one help me to have a complete list of documents / activities and their related codes or a useful link.

Many Thanks

__________________
A thousand-mile journey begins with the first step.
Register to Reply
Interested in this topic? By joining CR4 you can "subscribe" to
this discussion and receive notification when new comments are added.

"Almost" Good Answers:

Check out these comments that don't yet have enough votes to be "official" good answers and, if you agree with them, vote them!
Guru

Join Date: Feb 2008
Location: Van Nuys, CA
Posts: 563
Good Answers: 33
#1

Re: ENGINEERING DOCUMENT CODING

04/26/2008 3:47 AM

Here's the problem I always run into with that type system: What do you do when a document is a combination of two or more "codes"?
Leave the document naming simple, and use a database (or document management system) for classification.

Register to Reply
Associate

Join Date: Sep 2007
Posts: 49
Good Answers: 1
#2
In reply to #1

Re: ENGINEERING DOCUMENT CODING

04/26/2008 3:54 AM

My company policy is to have a unique code for each type of document to extinguish the document type from the document number or document file name.

__________________
A thousand-mile journey begins with the first step.
Register to Reply
Guru

Join Date: Jan 2008
Posts: 1753
Good Answers: 59
#3

Re: ENGINEERING DOCUMENT CODING

04/26/2008 8:47 AM

If you are serious - instead just making something up on the spot - go to your local library. Ask the librarian for a book about their classification system. It has the advantage, that it works and expandable.

Register to Reply
Guru
Canada - Member - If there is a way to screw someting up, there is someone to do so! Safety - Hazmat - New Member

Join Date: Mar 2007
Location: Iqaluit, NU. Canada
Posts: 1854
Good Answers: 140
#4

Re: ENGINEERING DOCUMENT CODING

04/26/2008 7:29 PM

This may prove to be a real challenge. I have been involved in several such efforts. On the whole the following is true... In order to succeed, you need to get everyone involved to agree to the naming convention that is put in place. You need to get all of the stake holders, in your organization, together and hammer it out on how the standard is to be written. That has always been one of the first things achieved when the overall attempt was a success. When this crucial step was never accomplished, failure would soon happen afterwards.

__________________
Joe Contractor to Electrical Inspector, "What do you mean you are going to make me follow the code?".
Register to Reply
Associate
South Africa - Member - Member Shonver

Join Date: Apr 2008
Location: Cape Town, South Africa
Posts: 51
Good Answers: 2
#5
In reply to #4

Re: ENGINEERING DOCUMENT CODING

04/27/2008 2:07 AM

I want to agree with this, and add:

There are many document types, and I suppose it would be useful to know all the possibilities but, in the end, you'll end up with a system (or document types) that are suited to your company specifically. The best is to work out a system, define what document types you want to use in the organisation, and publish a typical product data structure* that all can work to. In the absence of such a template, you'll get a never-ending string of requests for new document types. That being said, I'm not suggesting that your systems should be uncompromising/inflexible, just that it should evolve around a well-considered framework.

*This could change depending on what phase of a project/product development cycle you are in.

HTH

__________________
DON'T PANIC
Register to Reply
Anonymous Poster
#13
In reply to #5

Re: ENGINEERING DOCUMENT CODING

04/27/2008 11:57 PM

DEAR SIR,

I WILL SUGGEST YOU SIX DIGIT CODE NO. FIRST THREE DIGIT ARE ALOTTED FOR DOCUMENT CODE NOS. AND LAST THREE DIGIT NOS. FOR DOCUMENT SERIAL NO. SIZE OF DOCUMENT BY A,B,C,D,E. HERE E FOR A4 SIZE ,D FOR A3 SIZE, C FOR A2 SIZE , B FOR A1 SIZE & A FOR A0 SIZE DOCUMENTS S FOR SPECIFICATION.

e.g 301200/S INDICATE DOCUMENT SPECIFICATION OF ITEM TYPE 301 AND DOCUMENT SL NO IS 200. YOU HAVE TO MAINTAIN CODIFICATION REGISTER.

ASK FOR FURTHER QUERY IF ANY.

MAHENDRA

Register to Reply Off Topic (Score 5)
Guru

Join Date: Dec 2007
Location: Mumbai, India
Posts: 1983
Good Answers: 25
#6

Re: ENGINEERING DOCUMENT CODING

04/27/2008 3:47 AM

This problem is simple and should be solved in house with consultation with all involved in use of the documents. Different companies follow different systems for coding.

__________________
"Engineers should not look for jobs but should create jobs for others" by Dr.Radhakrishnan Ex President of India during my college graduation day
Register to Reply
Power-User
Technical Fields - Education - New Member Technical Fields - Technical Writing - New Member

Join Date: Sep 2006
Posts: 367
Good Answers: 1
#7

Re: ENGINEERING DOCUMENT CODING

04/27/2008 5:09 AM

The truth is in between Simple and Very Complicated task, with possibility to conflict with other coded components as mentioned above.

Your idea of letters is in most cases OK. Try three Capital Letters (remember - Search Engines that would ignore capitalization!). Number of combinations is huge. It is important you like it!

Inside document I recommend numbering system e.g. 1 - 1.1- 1.1.23 etc. so addressing to the Chapter (1, 2, etc.) and Paragraph (1.1 - 1.2 - etc.), to detailed content will be straight forward. Avoid Roman/Latin numbers I,V,X,C so popular in US legals.

Projects may use full words (as in Agencies) e.g. "Winter", "carrots" as an additional "military code", easy to address in Voice Mails.

Got them approved? It is the question. In my experience to get approved my concept I was stuck with ability to do real work -= continue my documentation/designing tasks. Waiting...waiting for final decision - so if must - go directly to The Highest Boss. (S)he will do the final approval anyway.

Register to Reply
Associate
South Africa - Member - Member Shonver

Join Date: Apr 2008
Location: Cape Town, South Africa
Posts: 51
Good Answers: 2
#8
In reply to #7

Re: ENGINEERING DOCUMENT CODING

04/27/2008 7:52 AM

Got them approved? It is the question. In my experience to get approved my concept I was stuck with ability to do real work -= continue my documentation/designing tasks. Waiting...waiting for final decision - so if must - go directly to The Highest Boss. (S)he will do the final approval anyway.

You should motivate the speedy approval and implementation of your proposed system/procedure based on the value of the preservation of intellectual property to yhe organisation. Try to get it adopted as organisational policy- preservation of (accurate) product configuration data ensures that it can be replicated in the future, and that valuable IP is retained long after the engineers have moved on.

__________________
DON'T PANIC
Register to Reply
Power-User
Technical Fields - Education - New Member Technical Fields - Technical Writing - New Member

Join Date: Sep 2006
Posts: 367
Good Answers: 1
#10
In reply to #8

Re: ENGINEERING DOCUMENT CODING

04/27/2008 9:37 AM

Good point.

Did you always have a wise Boss?' God bless Engineers!

Register to Reply Off Topic (Score 5)
Guru

Join Date: Jun 2007
Posts: 719
Good Answers: 25
#9

Re: ENGINEERING DOCUMENT CODING

04/27/2008 9:34 AM

jt's pennyworth:

1. Leave room for additions:
Inevitably one needs to add "something" later - which can
make a mess of what would have been a straightforward system.

If there are e.g, 14 types of documents, define for 20.
marking the unused ones e.g. "unallocated" "other" whatever.

and:

2. Avoid using confusing symbols:
As in, 1 (one) l ("letter L) and the obvious 0 (nought) and O, etc.
Full stops also have problems, although used on legal papers.

and:

3. Build-in a cross reference:
Make the system such that there is more than one way of sourcing
a document. It can occur that the normal means cannot be applied.
Alternative search routes are a God send for e.g. torn edges, miss typed
entries, etc. A form of cross referencing is essential. (in my opinion.)

Hope this helps.

jt.

Have a free web page - on http://www.mfnb.at

Register to Reply
Associate
South Africa - Member - Member Shonver

Join Date: Apr 2008
Location: Cape Town, South Africa
Posts: 51
Good Answers: 2
#12
In reply to #9

Re: ENGINEERING DOCUMENT CODING

04/27/2008 1:55 PM

Good points

3. Build-in a cross reference: Make the system such that there is more than one way of sourcing a document. It can occur that the normal means cannot be applied. Alternative search routes are a God send for e.g. torn edges, miss typed entries, etc. A form of cross referencing is essential. (in my opinion.)

Some more:

  1. Put the document name/number on each page.
  2. Make the document type part of the title e.g:
    1. Generator control panel parts list
    2. Generator chassis assembly drawing
    3. Generator final assembly test procedure
__________________
DON'T PANIC
Register to Reply
Active Contributor

Join Date: Apr 2008
Location: India
Posts: 10
#11

Re: ENGINEERING DOCUMENT CODING

04/27/2008 1:02 PM

Dear Abbas,

It is indeed not very easy to do unless you can tell me all possible names of documents & drawings in your company/PROJECTS--like as said- CALCULATIONS/DATA SHEETS/SPECIFICATIONS/CIVIL/ELECTRICAL/MECHANICAL/POWER/TRANSPORT/HRD/LEGAL/COMMUNICATION/etc etc.

In the mean time, I will try my best to let you know some more interesting details in this regard.

All the best & awaiting details as above.

fourmdev

Register to Reply Off Topic (Score 5)
Participant

Join Date: Apr 2008
Posts: 1
#14

Re: ENGINEERING DOCUMENT CODING

04/28/2008 12:29 AM

in one of our projects we use the following numbering system...ven you can use it if you like

year-project name in shortform- client contract number- A-XXX-YY

A represents document...it could be replaced by B if it is drawing...similarly C , if its some Code..

XXX should be replaced by DTS for datsheets..spc for Specification...and similarly

YY-- reprents the revision..First revision-00...2nd revision-01

for example,

2008-KFGH-23546-A-DTS-00

this might be of some help,

best regards,

Prashant..

Register to Reply Score 1 for Good Answer
Guru
Canada - Member - New Member

Join Date: May 2006
Location: Montreal, Canada
Posts: 632
Good Answers: 11
#15
In reply to #14

Re: ENGINEERING DOCUMENT CODING

04/28/2008 9:03 AM

It is good to have some legible meaning in the numbering system, and it helps implementation as you will have some degree of difficulty having such a system accepted.

Some part legible, Some part incremental is a good start.

Keep it simple to avoid mistakes and to ease acceptance.

Any part of a code needs to add value (meaning), too much makes it unlivable.

Get buy-in from management and staff, as this requires effort and resources. (I have a saying that ISO creates employment...).

I have experienced a badly mounted system that did not get complete acceptance by staff and management. Since it was implemented a year after the company startup, many kept their own little system. The result was 5 incompatible systems in a 50 person company. Sales, Finances, Marketing, R&D, Engineering all have different prerogatives in such a system.

__________________
''What the hell has my a** got to do with magic?" Don Quixote
Register to Reply
Guru
Engineering Fields - Electromechanical Engineering - Technical Services Manager Canada - Member - Army brat Popular Science - Cosmology - What is Time and what is Energy? Technical Fields - Architecture - Draftsperson Hobbies - RC Aircraft - New Member

Join Date: Sep 2006
Location: Clive, Alberta, Canada
Posts: 5916
Good Answers: 204
#16

Re: ENGINEERING DOCUMENT CODING

04/28/2008 1:22 PM

Excellent Question, and one that I will soon have to address as well. I manage documentation for engineering and quality control, and have inherited a mess stretching back 5 years or more. I consulted a professional engineer last year regarding naming conventions for our solidworks part, assembly, and drawing files. Of course it ties in with the material inventory system but I will not have the opportunity to rename the parts in inventory, and as such, will have to create an amalgamation of names.

It will be most useful for us to have "Part" drawings, and models named after the inventory part number. The PE that I consulted showed me their system and it was a multi-term naming convention. the basic structure was

PRODUCT GROUP-ASSEMBLY-COMPONENT-SEQUENTIAL NUMBER.FILETYPE

eg

PRODUCT GROUP = HYDRAULIC DRILL PIPE HANDLER = "DPH"

ASSEMBLY = FLUID PUMPING UNIT = "HPU"

COMPONENT = PUMP MOUNT FOR PUMP TYPE XYZ = "PMT"

SEQUENTIAL = "0001"

FILE TYPE = ".SLDDRW"

Document name = DPH-HPU-PMT-0001.SLDDRW

This way, all the documents for this component group were listed together.

eg:

DPH-HPU-PMT-0001.SLDDRW

DPH-HPU-PMT-0001.SLDPRT

DPH-HPU-PMT-0001.SLDASM

DPH-HPU-PMT-0001.XLS (BOM)

DPH-HPU-PMT-0001.DOC (ASSEMBLY INSTRUCTIONS, ETC)

DPH-HPU-PMT-0001.JPG (PHOTO OF UNIT)

this system also makes it fairly easy to read and understand, and to generate new part numbers and drawing names.

Variation of this them can be used to create documentation for any document in the organization, I believe, and also make it possible to create software to manage the documentation, if required, and the term of the name are relatively easy to set up with radio buttons, or pick from a list. Our naming convention for our inventory system is more mnemonic, and can not be easily computerized.

Last year I also took a run at making software (VB and a pdf activeX) to do exactly this, where a given document of questionable name could be selected, and then radio buttons etc would be selected, and a new file name generated, and subsequently a new file name created. My basic premise was that all the "Published documents would be PDF, while authoring documents would be all other formats. I was going to rename all the published documents in a format that would include their current revision. (see image)

Register to Reply Score 1 for Good Answer
Associate

Join Date: Sep 2007
Posts: 49
Good Answers: 1
#18
In reply to #16

Re: ENGINEERING DOCUMENT CODING

04/30/2008 9:32 AM

Dear sirs,

Many thanks for your nice explanation about This matter, its very useful to me.

__________________
A thousand-mile journey begins with the first step.
Register to Reply
Associate
South Africa - Member - Member Shonver

Join Date: Apr 2008
Location: Cape Town, South Africa
Posts: 51
Good Answers: 2
#19
In reply to #18

Re: ENGINEERING DOCUMENT CODING

04/30/2008 11:07 AM

You may want to read up on the discipline of Configuration Management or Acquisition Management. It is a bit of a broader subject than the thread addresses. However, some of the comments and questions posed here indicate that consideration of the bigger picture would be well-advised.

At the risk of sounding pedantic, if your problem statement is "We need a standardised numbering system", you will get limited buy-in from Management (why change [read "spend money on"] something that apparently works?). If you say "We need to protect/preserve our Intellectual Property to ensure Consistent Product Quality and minimise time-wasting", they are more likely to start paying attention.

__________________
DON'T PANIC
Register to Reply
Anonymous Poster
#17

Re: ENGINEERING DOCUMENT CODING

04/29/2008 10:50 PM

My company uses a coporate database system (TIS), however, every dept and every company has their own ideas about how things should be done; language differences create many problems, especially in the area of training; implementation stategies were poorly thought out (at least initially) so that a mired mess ensued; reliance on classification of component attributes makes it virtually impossible for manufacturing to be flexible and lean at the same time; and the list goes on.

So the best efforts of our "standards" dept is wasted because they create more variation than is really necessary and the result is something that approaches structured chaos borderline insanity. (we speculate about how long it will take before this massive database will collapse under its own weight).

Whatever you decide on keep it simple, keep it flexible, and most importantly, enforce the rules.

Register to Reply
Register to Reply 19 comments

"Almost" Good Answers:

Check out these comments that don't yet have enough votes to be "official" good answers and, if you agree with them, vote them!
Copy to Clipboard

Users who posted comments:

Abbas (2); Anonymous Poster (2); chrisg288 (1); fourmdev (1); gigaconcept.com (1); jt (1); leveles (1); North of 60 (1); pantaz (1); prashantsuv (1); Shonver (4); southern123 (2); suresh sharma (1)

Previous in Forum: Muntain Pine Beetle   Next in Forum: Help about Martrix Converter

Advertisement