I am a technical writer, and I am using FOSS

I am a technical writer, and I am using FOSS


This story, Why technical writers aren’t using FOSS, appeared in on Newsforge in April, and I have to take issue with some of the assumptions.

First of all, I am technical writer, and I do use FOSS—in fact, I’m a technical writer that documents FOSS technology using FOSS tools.

At MySQL, where I am a member of the documentation team, we use DocBook XML to build the documentation that you see on the website, or that’s available through the PDFs that can be downloaded. In fact, you can even download the XML source we use.

The XML is formatted using standard tools, and we use Apache FOP to translate the output into the various formats.

For many of my other writings—see MCslp.com—I use FOSS software when available or appropriate for the client or target in question. Here at Free Software Magazine, submissions are in XML, and what tool you use for that is entirely up to you.

I use emacs a lot, although for most XML work, including MySQL, FSM, ServerWatch and some IBM work I’ll use the <oXygen/> XML editor. It’s not FOSS, but it is a very good piece of XML editing software. Most of my book publishers, however, still use Word. I could use OpenOffice.org, but as a Mac user, I prefer to ensure that the application I’m using is 100% compatible with the publisher’s systems, and I see no reason to use FOSS software when I own licenses for the same applications my publisher uses.

As to the comment from the original article:

Another point that may be difficult for members of the FOSS communities to understand is that, although tech writers often keep typically long corporate hours and may work alongside FOSS programmers, few express any inclination to learn more about computing or to gain more control over how they spend most of their days.

I really have to take issue. I do not remotely believe that the majority of technical writers are technically ignorant. Many of them are writing on technical topics and—certainly in the case of the majority of people I work with inside and outside of MySQL—we all come from a heavy computing or programming background. In fact, I’ve spent my life trying to get away from programming, even though for the last seven years, I’ve spent 100% of my life writing about programming, or simply writing software like Cheffy.

I really can’t agree with the article, if taken on the title and some spots of content. In reality though, if you read the full article through, it seems to be more of a “Why aren’t FOSS tools as good as commercial ones”, using us technical writers as justification for why that might be the case.

Category: 

Comments

David Sugar's picture

I start from latex, and transform that as needed to html, pdf, etc. But it is a pain to edit and maintain that way, although xml is not immediately a perfect solution on it's own either, as it is designed for machine parsing more so than human reading :). I would love to start from an editor that produces transformable xml for feeding to other formats, and with the backend transformation tools. I have this starting from tex today.

Author information

Martin Brown's picture

Biography

Martin “MC” Brown is a member of the documentation team at MySQL and freelance writer. He has worked with Microsoft as an Subject Matter Expert (SME), is a featured blogger for ComputerWorld, a founding member of AnswerSquad.com, Technical Director of Foodware.net and, and has written books on topics as diverse as Microsoft Certification, iMacs, and free software programming.

Most forwarded

Interview with Dave Mohyla, of DTIDATA

Dave Mohyla is the president and founder of dtidata.com, a hard drive recovery facility based in Tampa, Florida.

TM: Where are you based? What does your company do?
DTI Data recovery is based in South Pasadena, Florida which is a suburb of Tampa. We have been here for over 10 years. We operate a bio-metrically secured class 100 clean room where we perform hard drive recovery on all types of hard disks, from laptop hard drives to multi drive RAID systems.

Anybody up to writing good directory software?

Since the very beginning, directories (of any kind) have had a very central role in the internet. (I have recently grown fond of Free Web Directory. Even Slashdot can be considered a directory: a collection of great news and invaluable user-generated comments. As far as software is concerned, doing a quick search on Google about software directories will return the free (as in freedom) software directories like Savannah, SourceForge, Freshmeat and so on, followed by shareware and freeware sites such as FileBuzz, PCWin Download Center and All Freeware (great if you're looking for shareware and freeware, but definitely less comprehensive than their free-as-in-freedom counterparts).

Interview with Mark Shuttleworth

Mark Shuttleworth is the founder of Thawte, the first Certification Authority to sell public SSL certificates. After selling Thawte to Verisign, Mark moved on to training as an astronaut in Russia and visiting space. Once he got back he founded Ubuntu, the leading GNU/Linux distribution. He agreed on releasing a quick interview to Free Software Magazine.

Is better education the key to finding better software?

I read David Jonathon's article Anybody Up To Writing Good Directory Software? the other day, which got me thinking about software directories in general. As David mentioned, many of the software directories one finds when doing a quick google search are free as in beer, not as in freedom. But what interests me is the software directories that already exist, providing a combination of both free as in beer software, and open source software. Sites such as Freeware Downloads and Shareware Download don't advertise themselves as providing free as in liberty software, but each of them have a good selection of open source software available... if you know where to look.

Most emailed

Free Open Document label templates

If you’ve ever spent hours at work doing mailings, cursed your printer for printing outside the lines on your labels, or moaned “There has got to be a better way to do this,” here’s the solution you’ve been looking for. Working smarter, not harder! Worldlabel.com, a manufacture of labels offers Open Office / Libre Office labels templates for downloading in ODF format which will save you time, effort, and (if you want) make really cool-looking labels

Creating a user-centric site in Drupal

A little while ago, while talking in the #drupal mailing list, I showed my latest creation to one of the core developers there. His reaction was "Wow, I am always surprised what people use Drupal for". His surprise is somehow justified: I did create a site for a bunch of entertainers in Perth, a company set to use Drupal to take over the world with Entertainers.Biz.

Update: since writing this article, I have updated the system so that the whole booking process happens online. I will update the article accordingly!

So, why, why do people and companies develop free software?

More and more people are discovering free software. Many people only do so after weeks, or even months, of using it. I wonder, for example, how many Firefox users actually know how free Firefox really is—many of them realise that you can get it for free, but find it hard to believe that anybody can modify it and even redistribute it legally.

When the discovery is made, the first instinct is to ask: why do they do it? Programming is hard work. Even though most (if not all) programmers are driven by their higher-than-normal IQs and their amazing passion for solving problems, it’s still hard to understand why so many of them would donate so much of their time to creating something that they can’t really show off to anybody but their colleagues or geek friends.

Sure, anybody can buy laptops, and just program. No need to get a full-on lab or spend thousands of dollars in equipment. But... is that the full story?

Fun articles

Santa Claus - the most successful open source project

It dawned on me the other day, as I was shopping for the dozens of gifts it seems I have to buy every December, that Santa Claus is the most successful open source project in history. (Bridget @ Illiterarty would agree with that). Santa Claus is essentially a marketing development that is embodied by everyone who stuffs a sock, gives a gift, hosts a dinner or wishes Merry Christmas over the holiday season.

Most emailed

Editorial

When I first started thinking about Free Software Magazine, I was feeling enthusiastic about the dream. I had Dave, Gianluca, and Alan willing to help me, I had established members of the free software community willing to help me out, I had writers volunteering their time and energy for free, and I had a generous offer from OpenHosting for servers, all before I'd proved myself. There was a sense of excitement in the air, and I thought maybe, just maybe, I could make this work.

Free Software Magazine uses Apollo project management software and CRM for its everyday activities!