Re: Technical Writing with LaTeX

Subject: Re: Technical Writing with LaTeX
From: "Janet M. Swisher" <swisher -at- enthought -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 05 Apr 2005 11:48:12 -0500


Isaac Waisberg wrote:
>
> I find LaTeX an amazing tool and I often wonder why is it neglected by
> technical writers. The main motivation for its development was the
> need to present technical information clearly and beautifully. In
> Knuth's words, TeX is a ``typesetting system intended for the creation
> of beautiful books---and especially for books with a lot of
> mathematics.''
>
> I found very few references to LaTeX in techwr-l among them: ``LaTeX,
> a professional typesetting program, is free software, but, like
> QuarkExpress, is a poor choice for documents that will be frequently
> revised'' (http://tinyurl.com/69nx9).
>
> Why do you think LaTeX is neglected by technical writers?
>

For me, it's mainly that modifying templates is such a pain. I've done a little bit of that, getting hubbie's dissertation to meet his university's formatting guidelines. That was minor tweaks like changing the page header for TOC continuation pages. I didn't even try to touch the fonts or the basic layout.

There are graphical editors for LaTeX, such as Scientific Word ($$) and LyX (free), which aren't exactly WYSIWYG, but claim to be WYSIWYM (what you see is what you mean), in that they show the structure of the document. But I'm not aware of any graphical tools that help with LaTeX style or package modifications.

At a previous contract job, the engineers chose Doxygen to generate API documentation. I considered using the LaTeX output from Doxygen to generate PDFs, but it would have been a huge challenge to match the house templates (for Word and FrameMaker), and nobody else there would have been able to maintain the LaTeX styles after I left. So I chose not to use it, even though the alternative was a somewhat convoluted process involving HTMLDOC, Word, and Acrobat; I could at least be confident that other tech writers would be able to handle the pieces of that puzzle.

My current employer sponsors an open source library of scientific functions. A few months back, the user community voted to adopt LaTeX as the format for documentation for the library; this is not too surprising, as the users are engineers and scientists, mainly academics, who are already familiar with LaTeX. (Also, handling equations well is a major requirement in this case.) OTOH, none of them has actually contributed any docs since that vote was taken. ;-)

For those who might be interested, Jack Lyon's Editorium newsletter recently had a series of articles on how to take content authored in Word and typeset it in LaTeX.

Excellent Typesetting, 1/6/05: <http://lists.topica.com/lists/editorium/read/message.html?mid=1718169469>
Excellent Typesetting, Part 2, 1/26/05: <http://lists.topica.com/lists/editorium/read/message.html?mid=1718286586>
Excellent Typesetting, Part 3, 2/2/05: <http://lists.topica.com/lists/editorium/read/message.html?mid=1718327936>
Excellent Typesetting, Part 4, 2/9/05: <http://lists.topica.com/lists/editorium/read/message.html?mid=1718368985>
Excellent Typesetting, Part 5, 2/23/05: <http://lists.topica.com/lists/editorium/read/message.html?mid=1718444865>

--
Janet Swisher --- Senior Technical Writer
Enthought, Inc. http://www.enthought.com



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
http://www.webworks.com/techwr-l

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Previous by Author: RE: Good White boards?
Next by Author: Re: 'Transparent to the User'
Previous by Thread: RE: Technical Writing with LaTeX
Next by Thread: Re: Technical Writing with LaTeX


What this post helpful? Share it with friends and colleagues:


Sponsored Ads