Tech Manual Writing

rileyesi · Joined: 19 Dec 2006 Posts: 398

Hi,

I am looking for a method to make my tech manuals look better (I really stink at tech writing!). Currently, I am using Word for the text part and I am importing drawings I made using AutoCAD for the diagrams, layouts, etc. The problem is when I import the AutoCAD drawing, the lines and text are very light compared to the Word text.

By the way, the method I am using to import the AutoCAD stuff is to insert an object (as opposed to importing a picture). Maybe there is a better way??

Does anyone have a better sugggestion as to a software solution?

As always, Thanks and Regards,

Pete

bzijlstra · Posted: Fri Apr 25, 2008 3:05 pm Post subject: Doxygen?

You might have a look at Doxygen

Source code documentation generator tool

Search with Google.

Have fun
Ben Zijlstra

rileyesi · Joined: 19 Dec 2006 Posts: 398

Ben,

Thanks for the reply.

Doxygen looks like a great product, but it doesn't suit my needs, as far as I can see. It seems to be for documenting software. I need a more general solution.

I have product drawings, wiring diagrams, block diagrams of systems that have components that are in different buildings, etc. that I have drawn using AutoCAD. I need to write manuals showing how to install instrumentation systems, displays, power supplies, lightning arrestors, etc. Not software.

Maybe Doxygen is the solution. I'll look deeper into it.

Thanks for the tip!

Regards,

Pete