×
INTELLIGENT WORK FORUMS
FOR ENGINEERING PROFESSIONALS

Log In

Come Join Us!

Are you an
Engineering professional?
Join Eng-Tips Forums!
  • Talk With Other Members
  • Be Notified Of Responses
    To Your Posts
  • Keyword Search
  • One-Click Access To Your
    Favorite Forums
  • Automated Signatures
    On Your Posts
  • Best Of All, It's Free!
  • Students Click Here

*Eng-Tips's functionality depends on members receiving e-mail. By joining you are opting in to receive e-mail.

Posting Guidelines

Promoting, selling, recruiting, coursework and thesis posting is forbidden.

Students Click Here

Jobs

Software for Installation/Operation/Maintenance manuals
9

Software for Installation/Operation/Maintenance manuals

Software for Installation/Operation/Maintenance manuals

(OP)
I hope I've found an appropriate forum for this question.

We make basic IO&M manuals in Microsoft Word. These range from 1 to 100 pages, and given the complexity of Word's formatting capability and the size of the documents, can be unproductive and extremely frustrating. Our users are not desktop publishers either - I would describe this as a graphics-laden word processing application. The final output is a PDF file or print copy of the manual (we're not into those fancy hyperlinked digital manuals I've seen in some industries). A feature for handling multiple languages would be nice but not a priority. We need to keep the editing of these documents easy enough that multiple users in the company can be competent to work with these documents.

Instead of Word, here are some options:
- WordPerfect (same capabilities of Word, just 'better')
- Adobe Framemaker (more desktop publishing in nature, more training required)
- Madcap MadPac (seem geared directly toward technical manuals)
- Others?

I welcome your input, as we are not a big organization and we need this to work well.

RE: Software for Installation/Operation/Maintenance manuals

Open Office.

RE: Software for Installation/Operation/Maintenance manuals

Word is the best. We used to work with Framemaker in the past, but that requires more training as you already wrote. Nowadays all our manuals are made in Microsoft Word.

RE: Software for Installation/Operation/Maintenance manuals

(OP)
How you do manage the formatting nightmares? Most of the formatting in our documents is inconsistent and gets corrupted. There are numerous workarounds in the formatting.

I'm pretty computer savvy and I've read some references that try to explain the Word formatting style and the complexity is simply bewildering. I'm halfway motivated to find another software simply out of spite because I'm offended that Microsoft would believe the Word formatting structure is what the world should conform to.

David

RE: Software for Installation/Operation/Maintenance manuals

Like most tools, if you take the time to learn how to use it, and use it correctly, Word works well.

I've done stuff far larger and more complicated than a 100 page manual.

RE: Software for Installation/Operation/Maintenance manuals

Quark or Adobe's InDesign.

RE: Software for Installation/Operation/Maintenance manuals

I've never known a serious technical publisher that liked Word, for the reasons you state.

We use framemaker I believe, or did until we went to the fancy html semi imbedded docs or whatever we have now.

Posting guidelines FAQ731-376: Eng-Tips.com Forum Policies http://eng-tips.com/market.cfm? (probably not aimed specifically at you)
What is Engineering anyway: FAQ1088-1484: In layman terms, what is "engineering"?

RE: Software for Installation/Operation/Maintenance manuals

Going out on a limb here, but how about AutoCAD (or whatever CAD software you already use)?

Don't dismiss it out of turn: If you only need annotated graphics, then what is a CAD file after all?

Over the years I've moved back and forth on the subject. I produce documents on a pretty regular basis, and AutoCAD "almost" is convenient enough to use for this purpose, in my environment. Maybe it could be a bit more convenient for someone else. The current versions can be configured with templates to prepare numerous page layouts in advance; this can be done rather automatically. From the fundamental "model" space you can arrange the drawings and text there, within a series of border spaces that fit each of the page layouts. From there you use the "publish" command instead of "plot", and all of the pages get plotted together into one DWF output file, or sent to the printer as one batch. This DWF can be converted into a PDF in one step, too.

A lot of my documents lose some crispness when I swap graphics/drawings out of CAD and into Word. I can save that step by abandoning Word for some documents. From a revision control point of view, if ALL of the drawings and text are in ONE file, in this case the CAD file, then suddenly there is one tracked document per revision, not umpteen. YAY! Things you find in Word like headers and footers? In AutoCAD they can be attribute blocks. The ATA chapter and section numbers? Separate fields and change them at will.

Now there are some folks who can't even change the font style from TXT to SIMPLEX or something else nicer, but engineers do tend to get along with CAD jockeys.

STF

RE: Software for Installation/Operation/Maintenance manuals

We used to produce a load of manuals and found Word difficult when handling a lot of graphics. The workaround for us was to use PowerPoint. It handles the pictures with ease and the text is carried in "text boxes" which you can place whereever you want on the page.

DOL

RE: Software for Installation/Operation/Maintenance manuals

We use InDesign as well.

"Art without engineering is dreaming; Engineering without art is calculating."

Have you read FAQ731-376: Eng-Tips.com Forum Policies: Eng-Tips.com Forum Policies to make the best use of these Forums?

RE: Software for Installation/Operation/Maintenance manuals

Take a look at 3DVIA Composer. It is pretty powerful software that is fully CAD integrated for technical publications.

Dan

www.eltronresearch.com
Dan's Blog

RE: Software for Installation/Operation/Maintenance manuals

If the complexity of Word is a problem for you then you most certainly do not want to tackle Adobe InDesign or whatever they call it this week.

RE: Software for Installation/Operation/Maintenance manuals

geesamand, I do pretty much what you describe, a Word doc with a few figures and a table or two. Word drives me crazy what with the formats jumping around and changing all the time. The worst, to me, is trying to dump in a picture, I never know where it will land or how it will be formatted. Admittedly I am not well trained in Word. There must be something simpler to use, but Word is what I am stuck with.

Regards,

Mike

RE: Software for Installation/Operation/Maintenance manuals

geesamand,

Word, and the very similar Open (Libre) Office actually are very powerful, and the overwhelming probability is that you don't know how they work. WordPerfect works the way you probably think Word does. This makes it more user friendly.

In Word, pull up and study the Styles and Formatting menu. In Word, you should not format text as you go. You should have a set of predefined formats which you apply to your text. Then, you can make style and formatting decisions, and quickly apply these to the whole document. You do not want to go through a hundred page document, changing the level two headers to 16pt Comic Sans, or any other font, for exmaple.

--
JHG

RE: Software for Installation/Operation/Maintenance manuals

For internal assembly work instructions we sometimes use our CAD system. We actually have a template for this separate from regular drawings. However, for serious customer facing docs it's a bit limited. Though for the kind of instructions you get in flat pack furniture it may well be adequate.

Posting guidelines FAQ731-376: Eng-Tips.com Forum Policies http://eng-tips.com/market.cfm? (probably not aimed specifically at you)
What is Engineering anyway: FAQ1088-1484: In layman terms, what is "engineering"?

RE: Software for Installation/Operation/Maintenance manuals

I have used Word for many such projects. Once you figure it out (Use the HELP funtion) - it should work just fine.

There are also "HELP" type software program that you use to make manuals and "HELP" sections for proprietary software. Best thing they do is allow indexing, table of content, etc

BUT again - you must learn how to use them. Google "Help Software"

RE: Software for Installation/Operation/Maintenance manuals

http://www.ptc.com/product/arbortext/

----------------------------------------

The Help for this program was created in Windows Help format, which depends on a feature that isn't included in this version of Windows.

RE: Software for Installation/Operation/Maintenance manuals

(OP)
I think our document editors (remember: this task is nobody's full-time job) are in the boat SnTMan described. The practical thing to do, as I see it, is to find some best practices and see if that cleans up the problems. We can handle graphics ok, it's the uncontrollable formatting that makes life difficult for us. It seems, based on what drawoh described, that there are many ways to do things in Word, and most of them are wrong in the practical sense. Given how often the Word interface is drastically rewritten and reshuffled, I've been happy just to find a command that meets my need, much less the "best" function.

If anyone has some links to a best practices resource, that would be appreciated. (I don't mind buying one of those 1-2" thick books if it covers this question really clearly).

If we fail we'll be searching for another program.

RE: Software for Installation/Operation/Maintenance manuals

I completely agree with SnTMan about graphics jumping all over the place in Word - but one little workaround (a typical "mechanical engineering" solution to the problem) is to put a table into the document and then paste the graphics into a cell in the table. The table can be a one-row/one column affair if needs be. If the table is then formatted to be without borders then no-one reading the paper/pdf form of the document will know how you cheated.

DOL

RE: Software for Installation/Operation/Maintenance manuals

Out on a limb here.
I use Help and Manual... It is a help authoring tool. Deals with graphic easily and can publish to paper, ebooks, as well as the web, and normal help files. VERY similar to instruction operation and maintenance manual requirements...

RE: Software for Installation/Operation/Maintenance manuals

Word can be worked. The biggest issue with Word is that there is generally several different ways of getting nearly identical print results.

However, you aren't really just asking for something the writes documents, per se., you are trying to publish books. Here's a comparison of Adobe InDesign and Quark Xpress, which appear to be the two obvious choices for book publishing.

Also, there are lots of online resources for publishers: http://www.bookcatcher.com/index.php One option is to query actual publishers for their requirements for book submissions.

TTFN
FAQ731-376: Eng-Tips.com Forum Policies

RE: Software for Installation/Operation/Maintenance manuals

I've never used it, but I just noticed that my full MS Office installation included "Microsoft Publisher".

RE: Software for Installation/Operation/Maintenance manuals

Quote (Oldhydroman)


I completely agree with SnTMan about graphics jumping all over the place in Word.
...

Word's default behaviour is to attach the graphic to a paragraph, and treat it like an enormous character. Right click on the graphic and look for menus. There are all sorts of options for determining what part of your document the graphic should be attached to, and how text should be formatted around it.

--
JHG

RE: Software for Installation/Operation/Maintenance manuals

(OP)
We do use publisher to write a particular type of graphics-laden report (think multipage brochure). I spoke to our one user who uses it regularly and she was not excited about using Publisher to write our manuals. The operations manuals are definitely more like a short book than a multipage brochure.

RE: Software for Installation/Operation/Maintenance manuals

If you want to get around the formatting issues, there are now commercially available packages (free to enterprise) designed to allow rapid knowledge capture for work instructions and SOPS with text and images through a functionally specific user interface and then autoformat the information in a PDF document in a variety of styles. Many of these packages include full revision control capabilities and higher end packages include the ability to integrate with other business systems (ERP) and allow for paperless deployment, electronic sign-off etc.

RE: Software for Installation/Operation/Maintenance manuals

Such as?

----------------------------------------

The Help for this program was created in Windows Help format, which depends on a feature that isn't included in this version of Windows.

RE: Software for Installation/Operation/Maintenance manuals

Well, depending what blucas means, Interactive Product Animator is partially CAD integrated. It will produce a canned interactive web page and a pdf version. Or at least it would about 5 years ago, it may be better, different, extinct... now.

Adobe 3D does some stuff to.

Posting guidelines FAQ731-376: Eng-Tips.com Forum Policies http://eng-tips.com/market.cfm? (probably not aimed specifically at you)
What is Engineering anyway: FAQ1088-1484: In layman terms, what is "engineering"?

RE: Software for Installation/Operation/Maintenance manuals

2
@dgallup -

In full disclosure, I work for one of the software companies that provides such a solution but try to provide information on forums such as this in a noncommercial manner. The most commonly seen packages (in alphabetical order) can be found at

www.proplanner.com
www.proworksinfo.com
www.sequencesoftware.com
www.visualfactory.net

I would be happy to talk with you further.

Barry Lucas
www.sequencesoftware.com

Red Flag This Post

Please let us know here why this post is inappropriate. Reasons such as off-topic, duplicates, flames, illegal, vulgar, or students posting their homework.

Red Flag Submitted

Thank you for helping keep Eng-Tips Forums free from inappropriate posts.
The Eng-Tips staff will check this out and take appropriate action.

Reply To This Thread

Posting in the Eng-Tips forums is a member-only feature.

Click Here to join Eng-Tips and talk with other members!


Resources