LWN.net Logo

Technical Writing Using OpenOffice.org Writer (O'ReillyNet)

Technical Writing Using OpenOffice.org Writer (O'ReillyNet)

Posted Aug 27, 2004 19:21 UTC (Fri) by cpm (subscriber, #3554)
In reply to: Technical Writing Using OpenOffice.org Writer (O'ReillyNet) by horen
Parent article: Technical Writing Using OpenOffice.org Writer (O'ReillyNet)

I do not agree at all.

Being able to outline the page, insert the graphics/illustrations/figures and
captions, see how the footnotes are going to land have a HUGE
impact on being able to generate a treatment that the
intended audience is going to actually READ.

Big problem with so-called Technical Writing, is that it is
often put together for those who HAVE to read it, rather
than inticing others to read it for personal edification, etc.

I hardly ever read included docs beyond any notes about
building and config switches, and go straight to the store
for the O'Reilly manual. The books that come with prop
software, go right in a ziplock, and go into the file
cabinet with the distro media.

Why? Because I find the overall presentation of the O'Reilly
books to be just my cup-o-tea. I can read them on the couch
and not feel like I /have/ to read it. It's almost like
reading for fun.

For this purpose, I much prefer a very basic text editor/spell
checker, like Abiword, or something, sometimes emacs for
the content generation, and Scribus for the doc prep.

I flip between the screens, see what is lacking, fix it, move
on to the next section.

I live it, I love it.

--


(Log in to post comments)

Technical Writing Using OpenOffice.org Writer (O'ReillyNet)

Posted Aug 27, 2004 19:22 UTC (Fri) by cpm (subscriber, #3554) [Link]

Oh, and I don't think OpenOffice can touch an ascii editor and scribus
for this task.

Technical Writing Using OpenOffice.org Writer (O'ReillyNet)

Posted Sep 9, 2004 1:58 UTC (Thu) by roelofs (subscriber, #2599) [Link]

Being able to outline the page, insert the graphics/illustrations/figures and captions, see how the footnotes are going to land have a HUGE impact on being able to generate a treatment that the intended audience is going to actually READ. [...] I hardly ever read included docs beyond any notes about building and config switches, and go straight to the store for the O'Reilly manual.

Hmmmm...I wrote my O'Reilly manual in troff using vi. Granted, the final layout and so forth was done by a real editor, but the "technical" and "writing" parts of the technical writing happened without any particular concern for page outlines, footnotes, locations of figures, and whatnot.

But maybe that's just me. [ObBayLink reference]

Greg

Copyright © 2008, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds
Powered by Rackspace Managed Hosting.