CAD Manual

[KGC]

Well i have given myself the role to updating our Office CAD Manual. Don't ask me why, i just did.

This really hasn't been touched in a while, i would say 5 years maybe. I am really looking for a good index set up. I really don't like the way ours is setup, and really don't want to spend the time to really tear it apart and re-organize the manual. All do another search for a manual, but if someone could just help me out with a decent index for a CAD Manual. Ill post mine here in a bit to show you what i have so far and what i am working with.

Thanks

[KGC]

TABLE OF CONTENTS


1.0 GENERAL

1.1 Introduction
1.1.1 Manual Organization
1.1.2 Other Documents
Project CAD Manual
1.1.3 Project CAD Coordinator
1.1.4 Learning Resources

1.2 Terminology
1.2.1 Sheet
1.2.2 BASE Files
1.2.3 External References
1.2.4 Paper Space
1.2.5 Model Space
1.2.6 Consultant Backgrounds
1.2.7 AutoCAD
1.2.8 Revit
1.2.9 Sheet File Assembly

1.3 Electronic Files
1.3.1 Computer Maintenance
1.3.2 Project Electronic File Structure
1.3.3 AutoCAD Directory on the Server “XXXXXXX”
1.3.4 Inter-Office Communications
Transfer of Electronic Files
Receiving Disks/Files
Sending Disks/Files

2.0 SETUP

2.1 CAD Project Setup
2.1.1 Network Project Setup
2.1.2 Copy Prototype Files
2.1.3 Revise Standard Title Block
2.1.? Revise Standard Sheet Set
2.1.4 Create Base Files
2.1.5 Archiving

2.2 CAD Sheet Setup
2.2.1 Standard Sheet Size: Imperial
2.2.2 Drawing Scales
2.2.3 Create Sheet Files
2.2.4 Sheet Organization
The Module System
Detail Layout & Numbering
2.2.5 Create Detail Sheets
2.2.6 Standard Sketch Format
2.2.7 Schedules



3.0 GUIDELINES

3.1 CAD File Naming Guidelines
3.1.1 Upper/Lower Case Convention
3.1.2 CAD File Naming Convention for Sheets
3.1.3 Sheet Files
3.1.4 Detail Drawings
3.1.5 Title Blocks
3.1.6 Information Blocks
3.1.7 Key Plans
3.1.8 Revision Blocks
3.1.9 Architectural Backgrounds
3.2 Sheet Numbering Guidelines
3.2.1 Sheet Numbering Convention
3.2.2 Discipline Codes
3.2.3 Sample Sheet Index

3.3 CAD Layering Guidelines
3.3.1 Layer Naming Convention
3.3.2 Architectural Layers

4.0 CAD STANDARDS

4.1 AutoCAD Standards
4.1.1 General
4.1.2 Base Files
4.1.3 Title Blocks
4.1.4 Revision Blocks
4.1.5 External Reference Files
4.1.6 Text Standards
4.1.7 Layering Standards
Freeze/Thaw versus On/Off Layers
4.1.8 Dimensioning
4.1.9 Line Types
4.1.10 Plotting
Batch Plotting
Plot Stamp
4.1.11 Pen Settings
4.1.12 Pen Width Convention/Line Weight Hierarchy
4.1.13 CAD Courtesy

4.3 Drafting Standards
4.3.1 Drawing Accuracy
4.3.2 Keynotes
4.3.3 Dimensions
4.3.4 Revisions Clouds
4.3.5 Leaders
4.3.6 Enlarged Areas
4.3.7 Standard Markup Color Code

4.4 Architectural Standards
4.4.1 Room Numbering Convention
4.4.2 Door Numbering Convention
4.4.3 Architectural Symbols
4.4.4 Architectural Abbreviations
4.4.5 Architectural Schedules
4.4.6 Hatch Patterns
5.0 CONSULTANT

5.1 Consultant-Specific Guidelines
5.1.1 Scale, Units, and Accuracy
5.1.2 Engineering Backgrounds
Saving for AutoCAD 14 Consultants
5.1.3 Seed Files
5.1.4 Architectural Backgrounds
5.1.5 Project Submittals

APPENDICES

Appendix A – Architectural Abbreviations
Appendix B – Architectural Sheet Numbers
Appendix C – Architectural Annotation Symbols
Appendix D - Layer Standards
Appendix E – Architectural (minimum) Layers
Appendix F – Layers
Appendix G – Text Heights
Appendix H – Pen Settings
Appendix J – Metric Conversion Chart
Appendix K – Scale Conversion Factors
Appendix L – Hatch Patterns
Appendix M – Dimensioning Guidelines
Appendix N – Dimensioning Guidelines Examples
Appendix O – Redlines Procedures
Appendix K – Client CAD Requirements
Appendix P – Standard ASK Sheet

[.chad]

wow. there is a lot of information going on there. im pretty sure there are a few standards on the forum, just have to search for them. try the standards forum (http://forums.augi.com/forumdisplay.php?f=264) as well as the general management forum.

[Kevin.Sturmer]

Well i have given myself the role to updating our Office CAD Manual. Don't ask me why, i just did...


This is a task which can easily get out of hand. Keep inforcement in mind. If you dot every i and cross every t - make sure you have a solid way to see that it gets followed.

Keeping things more on the loose/guideline side allows for flexibility and tends to get a higher return on its use.

Nail down the things which must be constant "text sixe, font(s) uses, etc" and provide the framework for the rest as more of an outline of best practices.

Save time and frustration all around.

[CADDmanVA]

TABLE OF CONTENTS


1.0 GENERAL

1.1 Introduction
1.1.1 Manual Organization
1.1.2 Other Documents
Project CAD Manual
1.1.3 Project CAD Coordinator
1.1.4 Learning Resources

1.2 Terminology
1.2.1 Sheet
1.2.2 BASE Files
1.2.3 External References
1.2.4 Paper Space
1.2.5 Model Space
1.2.6 Consultant Backgrounds
1.2.7 AutoCAD
1.2.8 Revit
1.2.9 Sheet File Assembly

1.3 Electronic Files
1.3.1 Computer Maintenance
1.3.2 Project Electronic File Structure
1.3.3 AutoCAD Directory on the Server “XXXXXXX”
1.3.4 Inter-Office Communications
Transfer of Electronic Files
Receiving Disks/Files
Sending Disks/Files

2.0 SETUP

2.1 CAD Project Setup
2.1.1 Network Project Setup
2.1.2 Copy Prototype Files
2.1.3 Revise Standard Title Block
2.1.? Revise Standard Sheet Set
2.1.4 Create Base Files
2.1.5 Archiving

2.2 CAD Sheet Setup
2.2.1 Standard Sheet Size: Imperial
2.2.2 Drawing Scales
2.2.3 Create Sheet Files
2.2.4 Sheet Organization
The Module System
Detail Layout & Numbering
2.2.5 Create Detail Sheets
2.2.6 Standard Sketch Format
2.2.7 Schedules



3.0 GUIDELINES

3.1 CAD File Naming Guidelines
3.1.1 Upper/Lower Case Convention
3.1.2 CAD File Naming Convention for Sheets
3.1.3 Sheet Files
3.1.4 Detail Drawings
3.1.5 Title Blocks
3.1.6 Information Blocks
3.1.7 Key Plans
3.1.8 Revision Blocks
3.1.9 Architectural Backgrounds
3.2 Sheet Numbering Guidelines
3.2.1 Sheet Numbering Convention
3.2.2 Discipline Codes
3.2.3 Sample Sheet Index

3.3 CAD Layering Guidelines
3.3.1 Layer Naming Convention
3.3.2 Architectural Layers

4.0 CAD STANDARDS

4.1 AutoCAD Standards
4.1.1 General
4.1.2 Base Files
4.1.3 Title Blocks
4.1.4 Revision Blocks
4.1.5 External Reference Files
4.1.6 Text Standards
4.1.7 Layering Standards
Freeze/Thaw versus On/Off Layers
4.1.8 Dimensioning
4.1.9 Line Types
4.1.10 Plotting
Batch Plotting
Plot Stamp
4.1.11 Pen Settings
4.1.12 Pen Width Convention/Line Weight Hierarchy
4.1.13 CAD Courtesy

4.3 Drafting Standards
4.3.1 Drawing Accuracy
4.3.2 Keynotes
4.3.3 Dimensions
4.3.4 Revisions Clouds
4.3.5 Leaders
4.3.6 Enlarged Areas
4.3.7 Standard Markup Color Code

4.4 Architectural Standards
4.4.1 Room Numbering Convention
4.4.2 Door Numbering Convention
4.4.3 Architectural Symbols
4.4.4 Architectural Abbreviations
4.4.5 Architectural Schedules
4.4.6 Hatch Patterns
5.0 CONSULTANT

5.1 Consultant-Specific Guidelines
5.1.1 Scale, Units, and Accuracy
5.1.2 Engineering Backgrounds
Saving for AutoCAD 14 Consultants
5.1.3 Seed Files
5.1.4 Architectural Backgrounds
5.1.5 Project Submittals

APPENDICES

Appendix A – Architectural Abbreviations
Appendix B – Architectural Sheet Numbers
Appendix C – Architectural Annotation Symbols
Appendix D - Layer Standards
Appendix E – Architectural (minimum) Layers
Appendix F – Layers
Appendix G – Text Heights
Appendix H – Pen Settings
Appendix J – Metric Conversion Chart
Appendix K – Scale Conversion Factors
Appendix L – Hatch Patterns
Appendix M – Dimensioning Guidelines
Appendix N – Dimensioning Guidelines Examples
Appendix O – Redlines Procedures
Appendix K – Client CAD Requirements
Appendix P – Standard ASK Sheet

You have to work for DOT right? That's the most succinct index I have ever seen. I may have to rework ours now. I'm jealous of how well organized your's is! :beer: :beer:

[robert.1.hall72202]

This is a task which can easily get out of hand. Keep inforcement in mind. If you dot every i and cross every t - make sure you have a solid way to see that it gets followed.

Keeping things more on the loose/guideline side allows for flexibility and tends to get a higher return on its use.

Nail down the things which must be constant "text sixe, font(s) uses, etc" and provide the framework for the rest as more of an outline of best practices.

Save time and frustration all around.

Best practices are definately the way to go. I wouldn't get too caught up in making sure everyone drives down the correct side of the road. Keep it simple and maintain consistency. Too many parameters are just asking the user to slip up. How many rules do you really want to maintain for each design? Let it go.

[CADDmanVA]

Best practices are definately the way to go. I wouldn't get too caught up in making sure everyone drives down the correct side of the road. Keep it simple and maintain consistency. Too many parameters are just asking the user to slip up. How many rules do you really want to maintain for each design? Let it go.

True dat! I've seen CADD Standards which were so voluminous and cumbersome that most drawings took almost as long for QA as they did to draft. Oh, and for the record, I did not witness this at the DOT.

[KGC]

no, we are Architectural.

And, i agree that too mnay rules and parameters can just get out of hand, and i have been in the process of getting this CAD Standards Manual updated, and creating some other documentation, and then having a CAD Day in the office.

My goal is not that everyone sits down and reads this book back to front on day 1, but i would like that everyone reads this in a week, and then we have another CAD Day (in house meeting if you will about CAD), and we then go over the Standards, i get some feedback and make sure that everyone is on the same page. I would only take up maybe 4-6 through out the week for these meetings, and in the process, also update all machines in the office, with the Standards for ACAD, and get our Office Standards Folder on the server organized and better located, so that its not a hassle to locate.

Detail libraries, tool palettes, SSM information, blank project shell folders will all be updated, and published after our CAD Days.

From here, I will know that everyone at least knows where these folders, documents, and files are, and have read, and have a basic understanding of the Standards that we NEED to start implementing.

Then at this point, maybe a monthly CAD Day, for either all of the CAD Staff, or just the high end users, to make sure that projects are running smoothly and the standards are being upheld correctly.

[robert.1.hall72202]

Passing out templates, blocks, and charts have been better than any cad standard
that I have produced. The standard is used as a reference tool. I can always use
the standard to reinforce common practices.

[-Brian-]

TABLE OF CONTENTS


1.0 GENERAL

1.1 Introduction
1.1.1 Manual Organization
1.1.2 Other Documents
Project CAD Manual
1.1.3 Project CAD Coordinator
1.1.4 Learning Resources

1.2 Terminology
1.2.1 Sheet
1.2.2 BASE Files
1.2.3 External References
1.2.4 Paper Space
1.2.5 Model Space
1.2.6 Consultant Backgrounds
1.2.7 AutoCAD
1.2.8 Revit
1.2.9 Sheet File Assembly

1.3 Electronic Files
1.3.1 Computer Maintenance
1.3.2 Project Electronic File Structure
1.3.3 AutoCAD Directory on the Server “XXXXXXX”
1.3.4 Inter-Office Communications
Transfer of Electronic Files
Receiving Disks/Files
Sending Disks/Files

2.0 SETUP

2.1 CAD Project Setup
2.1.1 Network Project Setup
2.1.2 Copy Prototype Files
2.1.3 Revise Standard Title Block
2.1.? Revise Standard Sheet Set
2.1.4 Create Base Files
2.1.5 Archiving

2.2 CAD Sheet Setup
2.2.1 Standard Sheet Size: Imperial
2.2.2 Drawing Scales
2.2.3 Create Sheet Files
2.2.4 Sheet Organization
The Module System
Detail Layout & Numbering
2.2.5 Create Detail Sheets
2.2.6 Standard Sketch Format
2.2.7 Schedules



3.0 GUIDELINES

3.1 CAD File Naming Guidelines
3.1.1 Upper/Lower Case Convention
3.1.2 CAD File Naming Convention for Sheets
3.1.3 Sheet Files
3.1.4 Detail Drawings
3.1.5 Title Blocks
3.1.6 Information Blocks
3.1.7 Key Plans
3.1.8 Revision Blocks
3.1.9 Architectural Backgrounds
3.2 Sheet Numbering Guidelines
3.2.1 Sheet Numbering Convention
3.2.2 Discipline Codes
3.2.3 Sample Sheet Index

3.3 CAD Layering Guidelines
3.3.1 Layer Naming Convention
3.3.2 Architectural Layers

4.0 CAD STANDARDS

4.1 AutoCAD Standards
4.1.1 General
4.1.2 Base Files
4.1.3 Title Blocks
4.1.4 Revision Blocks
4.1.5 External Reference Files
4.1.6 Text Standards
4.1.7 Layering Standards
Freeze/Thaw versus On/Off Layers
4.1.8 Dimensioning
4.1.9 Line Types
4.1.10 Plotting
Batch Plotting
Plot Stamp
4.1.11 Pen Settings
4.1.12 Pen Width Convention/Line Weight Hierarchy
4.1.13 CAD Courtesy

4.3 Drafting Standards
4.3.1 Drawing Accuracy
4.3.2 Keynotes
4.3.3 Dimensions
4.3.4 Revisions Clouds
4.3.5 Leaders
4.3.6 Enlarged Areas
4.3.7 Standard Markup Color Code

4.4 Architectural Standards
4.4.1 Room Numbering Convention
4.4.2 Door Numbering Convention
4.4.3 Architectural Symbols
4.4.4 Architectural Abbreviations
4.4.5 Architectural Schedules
4.4.6 Hatch Patterns
5.0 CONSULTANT

5.1 Consultant-Specific Guidelines
5.1.1 Scale, Units, and Accuracy
5.1.2 Engineering Backgrounds
Saving for AutoCAD 14 Consultants
5.1.3 Seed Files
5.1.4 Architectural Backgrounds
5.1.5 Project Submittals

APPENDICES

Appendix A – Architectural Abbreviations
Appendix B – Architectural Sheet Numbers
Appendix C – Architectural Annotation Symbols
Appendix D - Layer Standards
Appendix E – Architectural (minimum) Layers
Appendix F – Layers
Appendix G – Text Heights
Appendix H – Pen Settings
Appendix J – Metric Conversion Chart
Appendix K – Scale Conversion Factors
Appendix L – Hatch Patterns
Appendix M – Dimensioning Guidelines
Appendix N – Dimensioning Guidelines Examples
Appendix O – Redlines Procedures
Appendix K – Client CAD Requirements
Appendix P – Standard ASK Sheet

wow. very nice list. I don't suppose you want to post your manual for some of us to look around, do you? I'm curious how you mark up the info. :)

[KGC]

No not at the moment, maybe when its all said and done, i might repost, but thats all i have for now to show.

[jcoe]

Keep inforcement in mind.

I am currently putting the finishing touches on our CADD Standards, which I had to write from scratch. One thing I want to do from an enforcement standpoint is include a letter from the firm's CEO, sending a message to the staff that this is an important document. When I brought this up, I was asked to draft the letter for the CEO to review and sign. I am having trouble starting the letter, however, and was wondering if others had examples or ideas of language to include in the letter.

[abertigger]

I am currently putting the finishing touches on our CADD Standards, which I had to write from scratch. One thing I want to do from an enforcement standpoint is include a letter from the firm's CEO, sending a message to the staff that this is an important document. When I brought this up, I was asked to draft the letter for the CEO to review and sign. I am having trouble starting the letter, however, and was wondering if others had examples or ideas of language to include in the letter.

I would go for something around these lines ;

Dear CAD staff,

Follow the new CAD standard or die a very slow death

yours

CEO


:)

[jcoe]

I would go for something around these lines ;

Dear CAD staff,

Follow the new CAD standard or die a very slow death

yours

CEO


:)

As much as I would love to send this type of message I was thinking more along the lines of this:

"As our office continues to grow in its physical and technological prowess, it is becoming more evident that standards - as they apply to our daily operations – are of increasing importance. Therefore, the purpose of this document is to provide all staff with a common set of guidelines to follow – from file management to production of documents using various design software packages. Although this is a living document and changes are expected as our processes are further refined, it is important that we all adhere to theses standards in their current form to create a level of standardization and consistency within the office and among projects."

I came up with this while on my drive into work this morning, but this is where the thought stopped. It seems like a little more is needed.

[Misteracad]

The following exerpt from our CAD Standards doc may assist you. If I were drafting a letter to the staff, I would definitely use several lines from the following sections. Just replace "XXXX" with your company name and edit where necessary:

1 Purpose
The purpose of this document is to identify the minimum standards and/or procedures for the preparation of CAD drawings; and to achieve uniformity in appearance, content, and electronic organization, so that drawings prepared by various XXXX Technologies and/or outside Consultants, can ultimately be assembled into a single Electronic Document Management System (EDMS).

To that end, this Standard establishes requirements and procedures for the preparation and submission of CAD-based Drawings throughout the project life cycle. Adherence to this Standard insures that XXXX will receive and produce data in a consistent format. This consistency will improve the compatibility of these Drawings within each XXXX Technology and improve efficient overall exchange of data between our Clients and Consultants.

The CAD systems adopted by XXXX are comprised of several software applications. Throughout this manual, terminology and references will be made that are unique to these applications.

2 Scope
The Guidelines, Procedures, and Standards listed herein, are applicable to all Computer-Aided Design (CAD) drawings developed for any XXXX need, Technology, Project, etc. This includes drawings developed internally by XXXX personnel, as well as drawings developed for XXXX by outside entities such as participating Consultant, A&E firms, Contractors, Vendors, etc. that are involved with XXXX on any given project. In this document, the term Consultant will be used repeatedly and shall address all of the above contributors.

Any questions pertaining to the contents are to be addressed in writing to the IT - Engineering Application Support Team.

3 Responsibility
It is the responsibility of all XXXX CAD Operators, Designers, Engineers, Project Managers, and functional Supervisors, as well as outside Consultants, to ensure that the engineering documents and drawing packages produced for XXXX and/or XXXX's clientele conform to the procedures outlined in this Standard. However, the role of an individual assigned to a project determines the level of understanding required of this Standard. For CAD Operators, Designers, and Engineers, a thorough knowledge of all CAD-related elements associated with a project is crucial. The functional Supervisors and Project Manager however, only require a general knowledge of the Standard and the means by which it is engaged to create a project. Both levels of knowledge will be possible with this manual.

Accordingly, all drawings shall be legible, comprehensive, and shall contain sufficient information to clearly indicate the design intent.

Hope this helps!

[jaberwok]

Never use one word when ten will do.

[Comach]

The best advice I can give you on this subject is to break your Cad manual down into separate volumes, depending on subject content.

Users are more likely to use the cad manual if it is easy to access the data they specifically require - nothing worse than having to trawl through one large document to find one page of information. This also allows you to complete each volume separately and have it issued without having to wait for the full cad manual to be completed.

[-SL-]

While certainly not as detailed as kgrant's, I'll post my outline as well. Let me say that I know it's not perfect and there's room for improvement - I'll even take criticism if anyone wants to dish it out. Probably my biggest task at hand is to split this up into a Standards Document and a Manual. Right now, it's a Standards Document with a Manual intermingled (I inherited it this way).

The good thing is that it's a complete document. Everything you see here is detailed out. There's only three sections I haven't completed yet.

And for reference, I work for a Mechanical Contractor. We do commercial HVAC, Mech Piping and Plumbing.

1.0 Introduction
1.1 Purpose
1.2 Quality

2.0 Beginning a New Drawing
2.1 Preparing the File Structure
2.1.1 Job Numbers & Names
2.1.2 Drawing Folders
2.1.3 Other Folders
2.1.4 Establishing the Drawing Log
2.2 Preparing the Architectural Background
2.3 Selecting & Opening a Drawing Template/Border
2.4 XRef Setup
2.5 Numbering & Titling the Drawing
2.5.1 Drawing Packages Received
2.5.2 Drawing Number
2.6 Completing the Border Setup
2.7 Establishing the Correct Text Size
2.8 Equipment Creation/Modeling + Service Clearances
2.9 Using the Layer Translator

3.0 Drafting & Drawing Standards
3.1 Text Height
3.2 Text Style
3.3 Layers
3.4 Layer Script Files
3.5 Dimension Style
3.5.1 Quick Overview
3.5.2 Detailed Settings for Each Dimension Style
3.6 Annotation for Drawings
3.7 Annotation Scaling

4.0 Parts of a Drawing
4.1 Title Block
4.2 Revisions
4.2.1 Revision Block
4.2.2 Revision Cloud & Revision Delta
4.3 The Model & Geometry
4.4 Blocks & Wblocks
4.4.1 Creating a Block
4.4.2 Inserting a Block
4.4.3 Creating a WBlock
4.4.4 Inserting a WBlock
4.5 Tables
4.6 Object Enablers
4.6.1 Where to Find OEs

5.0 Drawing Options
5.1 Model Space / Paper Space
5.2 Workspaces
5.2.1 Managing the Workspaces
5.2.2 Workspace Settings
5.3 Tool Palettes
5.4 DesignCenter

6.0 AutoCAD Job File Management
6.1 Sheet Set Manager
6.2 Project Navigator Setup

7.0 Plotting
7.1 Plot Stamp
7.2 Setting Plot Parameters
7.3 Plot Styles (CTB/STB)
7.4 Plot Files
7.5 Plotters
7.6 KIP Accounting
7.6.1 Account Numbers
7.6.2 Entering Job Numbers for Copying & Scanning
7.7 Scanning a Drawing to a File
7.7.1 Scanning
7.7.2 Color Scanning
7.7.3 Retrieving Your Scanned Files
7.8 Using KIP Request
7.9 Plotting from AutoCAD to Plotters
7.10 Plot to PDF
7.11 Convert PLT to PDF
7.12 Scaling PDFs in KIP Request
7.13 Using Print History to Print
7.13.1 Editing a Past Print Job

8.0 Deliverables
8.1 The AutoCAD Standards Checker
8.2 Setting Up an FTP Site (for client use)
8.3 Drawing Tracking & Revisions
8.4 Finished Job File Structure


Appendix A – Tables
1.0 Insert Excel table from a data link
2.0 Updating an Excel table data link
2.1 Semi-automatic updating
2.2 Manual updating

Appendix B – Setting up an FTP site
B.1 Map a drive for the FTP site
B.2 Setting up the FTP for customer use
B.3 Sending the FTP info to the customer
B.4 About the VNC

Appendix C – Layer List

Appendix D – Drawing Tracking & Revisions
1.0 Starting the Drawing Log
1.1 Drawing log Location
1.2 Drawing log Coordination
2.0 Issue for Approval
2.1 Issue for Approval Revisions
3.0 Issue for Construction (to the PM & Foreman)
3.1 Issue for Construction Revisions
4.0 Layer Information

[RobertB]

The best advice I can give you on this subject is to break your Cad manual down into separate volumes, depending on subject content.

Users are more likely to use the cad manual if it is easy to access the data they specifically require - nothing worse than having to trawl through one large document to find one page of information. This also allows you to complete each volume separately and have it issued without having to wait for the full cad manual to be completed.Perhaps even better advice: move the thing to a wiki. After all, who ever reads the printed manual anyway?! :roll:

[pjohnson.137155]

I wrote a blog on documenting Cad standards, and the one thing I like is creating a CHM (help file). This then can be inserted into the help pull down and be indexed and searchable. I feel it makes it more user friendly which will get used more. You will find the blog at http://www.cadenhancement.com/2009/05/cad-standards-documentation.html

Just another idea

Patrick K. Johnson
http://www.cadenhancement.com

[Misteracad]

I wrote a blog on documenting Cad standards, and the one thing I like is creating a CHM (help file). This then can be inserted into the help pull down and be indexed and searchable. I feel it makes it more user friendly which will get used more. You will find the blog at http://www.cadenhancement.com/2009/05/cad-standards-documentation.html

Just another idea

Patrick K. Johnson
http://www.cadenhancement.com
Good blog post, and I think you are right on the mark. I might have to look into this for my company ;)

[Comach]

Perhaps even better advice: move the thing to a wiki. After all, who ever reads the printed manual anyway?! :roll:

Maybe the reason people don't read printed manuals is because they are normally too big - keep it small and manageable sized volumes then people will read them - and yes people do still prefer the printed form.

Furthermore, it is a quality document and consequently requires the normal review and approval procedures - so even if the end users don't want a printed copy the SOPs and QA procedures demand otherwise.

[traceyjj]

At a previous company I worked for I created the CAD manual which was all done as HTML pages, and linked into the AutoCAD menu.
Because it was in the AutoCAD menu, the cad users had no excuse for not knowing where to find the manual, or the latest blocks etc. as it was easy to update the "company" menu. I found there were far fewer cries for help when users knew that all the information they needed on a regular basis was generally in the menu.

[TerribleTim]

I too like the idea of the "Help File" for the CAD Manual. I tried it also, but it doesn't seem to get read either. Next I'm going to look int ogetting it into the ACAD Help Menu. Maybe that will help more than a desktop icon. :???:

[jaberwok]

Adding topics to the help file was quite common in the days of DOS but then came the need for the windows help compiler. Now, with HTML, it may again be worth going that way.

[TerribleTim]

I used a program called RoboHelp to build the last one I did. It is from Adobe. It is very good, and easy to use. I need to revisit it to see if I can make a CHM file with it. I'm not sure it has that capability, but it may.

[traceyjj]

Adding topics to the help file was quite common in the days of DOS but then came the need for the windows help compiler. Now, with HTML, it may again be worth going that way.
It certainly helped the people I worked with. The cad manual was a standards manual, and tips and tricks manual rolled into one. That way when someone else found a tip it used to get added to the manual. Because the staff members had their input, it used to get more use as they felt it was "theirs". It seemed to work quite well, and I ended up getting fewer "how do I do this" calls :)

[RobertB]

...That way when someone else found a tip it used to get added to the manual. Because the staff members had their input, it used to get more use as they felt it was "theirs".That's why I mentioned a wiki. Users have a direct way to submit content for addition to the wiki.

[TerribleTim]

Aren't you guys ever worried about the fact that wikis have no real quality assurance checking system? If anyone can input data, who verifies the validity of that data?

I'd rather handle the data myself than have users just changing it to the way they want it and then saying "Well, it's in the standards like that."

[traceyjj]

Tim, ours wasnt wiki based. It was just plain old HTML pages with only myself editing. But people submitted tips, and lisps to me. Once they were checked out, I amended the tips and tricks area accordingly. I left there before wikis became popular, so I wouldnt know whether or how that would work, but I would be interested to hear if/how people do this for their company :)

[cadtag]

Aren't you guys ever worried about the fact that wikis have no real quality assurance checking system? If anyone can input data, who verifies the validity of that data?

I'd rather handle the data myself than have users just changing it to the way they want it and then saying "Well, it's in the standards like that."

Would that not be the CAD Manager's job??????? He can certainly pay attention to changes on the Wiki --they would not be anonymous on an intranet, and most probably a wiki could be set up to notify him/her of any edits or new pages being added. If a problem user is adding spurious bad information, then he's easily identified and a one-to-one discussion can be held to iron out the problem.

A basic Help/Standards web site with a single author has update and currency issues. It's _hard_ to take the time to write between getting jobs out the door, solving problems, doing development, handling management expectations, kicking the cat, etc etc etc. That author becomes a bottleneck just as much as a gateway. It's an approach that minimizes the potential for problem edits, but also reduces the quality and public 'ownership' of the product. It can't get any better than he alone can make it, and it's his -- not the users.

Compiled HTML help is convenient to access, but a pain to update - since the files won't run off a network they need to be loaded on each PC. A Wiki really gives you the best of both worlds (and can certainly include static or protected pages that hold your cast-in-stone requirements)

[Comach]

Aren't you guys ever worried about the fact that wikis have no real quality assurance checking system?

Exactly my point.

A CAD Manual is a Quality Controlled document – this document requires an approval process – the ownership, editing and control of this document is with the originator. Edits and updates must be approved before implementation - revision control and approval signatures must be an integral part of the process.

Changes to a cad manual after approval and subsequent issue may have cost implications as well as impact to project schedules.

Cad Tips and Technotes should be considered separate to the content of a cad manual.

[RobertB]

Exactly my point.

A CAD Manual is a Quality Controlled document – this document requires an approval process – the ownership, editing and control of this document is with the originator. Edits and updates must be approved before implementation - revision control and approval signatures must be an integral part of the process.

Changes to a cad manual after approval and subsequent issue may have cost implications as well as impact to project schedules.

Cad Tips and Technotes should be considered separate to the content of a cad manual.We are using a wiki hosted by SharePoint. So I can control the published content.

[pjohnson.137155]

Wiki, help file, share point all good ideas, but the most important item is making it easy to use so it is used and viewed by the end user which will mean that your cad standards are adhered to.

I will throw this idea out there, what if you were to build logic into your cad files so if the user ask a question that section of the help will pop up. What i mean is say in the command prompt you type ?Layers and your standard layers pop up on the screen from where ever you have your standards saved. I do not think this would be to difficult to do.

What do you all think?

Patrick K Johnson
http://www.cadenhancement.com

[-SL-]

This is an interesting discussion that has developed here on the last couple of pages.

I think the argument can be made for a wiki and for the help file - with complately valid reasons for both methods.

For those that maintain a wiki... what's the "backup-ability" of the wiki's info? Can it be backed up reliably? (My thought process here is that the help file method has a good chance of staying backed up since it's just copying & saving a file or group of files.)

[Ken Cover]

I did some research a couple of years back because we really had no written standard. I found that having a committee formed with CAD Techs and Engineers/Arch would make it easier to create and implement.

After over a year of working out the details, we finally formed a Committee in April and are starting to get a good standard written. Since we are a Structural Firm, we have also used the National CAD Standard as a guideline for some of the items.

[RobertB]

For those that maintain a wiki... what's the "backup-ability" of the wiki's info? Can it be backed up reliably? (My thought process here is that the help file method has a good chance of staying backed up since it's just copying & saving a file or group of files.)The data on our SharePoint server is backed up just like any other server.