TheSwamp
CAD Forums => CAD General => CAD Standards => Topic started by: M-dub on January 29, 2009, 11:47:23 AM
-
I'm writing a new policy on the use of our document management system and I'm having a bit of a hard time arranging it. Some sections are quite short and others are fairly lengthy with a lot of subsections. The problem I'm having is whether I should just simply label them in sections like 1, 2, 3, and so on or whether I should get into organizing it into subsections like 3.1.a, 3.1.b, etc.
Does anyone know if there's a guideline on how to set documents of this nature up?
-
I'm writing a new policy on the use of our document management system and I'm having a bit of a hard time arranging it. Some sections are quite short and others are fairly lengthy with a lot of subsections. The problem I'm having is whether I should just simply label them in sections like 1, 2, 3, and so on or whether I should get into organizing it into subsections like 3.1.a, 3.1.b, etc.
Does anyone know if there's a guideline on how to set documents of this nature up?
The easier you make it to follow; the greater the chances are it will be followed.
-
I'm writing a new policy on the use of our document management system and I'm having a bit of a hard time arranging it. Some sections are quite short and others are fairly lengthy with a lot of subsections. The problem I'm having is whether I should just simply label them in sections like 1, 2, 3, and so on or whether I should get into organizing it into subsections like 3.1.a, 3.1.b, etc.
Does anyone know if there's a guideline on how to set documents of this nature up?
The easier you make it to follow; the greater the chances are it will be followed.
Which is what broght me to this point.
-
I'm writing a new policy on the use of our document management system and I'm having a bit of a hard time arranging it. Some sections are quite short and others are fairly lengthy with a lot of subsections. The problem I'm having is whether I should just simply label them in sections like 1, 2, 3, and so on or whether I should get into organizing it into subsections like 3.1.a, 3.1.b, etc.
Does anyone know if there's a guideline on how to set documents of this nature up?
The easier you make it to follow; the greater the chances are it will be followed.
Which is what broght me to this point.
Well how about start with a flow chart of the typical New document>>Check In/Out procedure.
Then link each of those steps in the process to the section of the document the explains it.
I think you might add 'sub' sections as required to organise the information, into coherent chunks.
Designing a document to present information of this nature is a combination of style, and simplicity. IMHO
-
Thanks Michael. I think I'm just going to go through it section by section and manually set up the numbering. I have a basic table of contents, but my goal here is to get a little more precise when referring people to specific phrases / sections of the document.
-
NOBODY IS GOING TO READ IT ANYWAYS!!
-
NOBODY IS GOING TO READ IT ANYWAYS!!
Please don't say that, Matt.
This is kind of a CYA document. I'll hand this out to everyone who needs it and when they ask questions that are covered in the document, I'll just ask them if they read it.
Besides, just because no one is going to read it doesn't mean it shouldn't be written.
-
NOBODY IS GOING TO READ IT ANYWAYS!!
Please don't say that, Matt.
This is kind of a CYA document. I'll hand this out to everyone who needs it and when they ask questions that are covered in the document, I'll just ask them if they read it.
Besides, just because no one is going to read it doesn't mean it shouldn't be written.
Dork: How do you do this?
Dub: Did you read the handout?
Dork: No. But you're here now, so how do you do this?
Dub: We have procedures in place for a reason. Did you go to the class?
Dork: Yeah, but I can't remember everything you went over. How do you do this?
Dub: *sigh*
-
Dork: How do you do this?
Dub: Did you read the handout?
Dork: No. But you're here now, so how do you do this?
Dub: I didn't think so... Here... Let me show you... again.
Dork: Thanks man, you're awesome! I should pay more attention to you!
Dub: whatever...
Actually, it IS there to be read and followed, but when that doesn't happen and something blows up to the point where our supervisor hears about it, he'll ask "Well, weren't you provided with standard procedures regarding this?" and at least I've achieved some degree of due diligence.
-
Just a quick question:
Is 4.2.ii.a a little too much?
-
Go for it!!