Rhonda Bracey: At Random

Two months ago, I set up an Amazon Store with technical writing books I recommend. Since then I’ve added other personal recommendations of books, DVDs, produce, appliances, etc. to the store. It was never meant to be a ‘get rich quick’ scheme… in fact, I just wanted it to be a reference source for other technical writers out there. If I made a few dollars in the process, that would be a bonus.

Well, the “bonus” after 2 months is $10.01 from seven sales. Amazon don’t send me a cheque (they don’t do PayPal…) until my ‘referral fees’ reach $100. So I could be waiting a *long* time.

Another excellent video from the people at CommonCraft – this time on using Del.icio.us and similar social bookmarking sites.

(http://www.youtube.com/watch?v=x66lV7GOcNU)

I have a new title: “Wiki gardener”! It’s a term used on JSPWiki.org for those who have the responsibility of keeping a Wiki weed and bug free, and it’s what I’ve been doing the past two days with a Wiki that was set up a year or so ago but that nobody’s taken care of since then. Just like an overgrown garden…

Anyhow, while I was reading the documentation over at JSPWiki.org (yes, Virginia – technical writers *do* read other people’s work!) and testing some stuff out on the Wiki, I got an error message. Standard incomprehensible stuff followed by some possible solutions, followed by this:

And don’t worry – it’s just a computer program. Nothing really serious is probably going on: at worst you can lose a few nights sleep. It’s not like it’s the end of the world.

It made me chuckle!

Thanks to a link on one of my technical writing discussion lists, I came across this great article written in 2005: “Wikiphilia – The New Illness“.

Normally, I’d just skim such an article as my only real exposure to Wikis has been via Wikipedia (as a user and very occasional editor) and on the periphery of Wiki implementations in software support and development teams.

However, for my new client I am likely to be very involved in organising one team’s Wiki. From the looks of it, this Wiki was set up about a year or so ago and since then it’s become a bit of a dumping ground—’disorganised chaos’ would seem to be the best description, even though it’s an oxymoron. And it doesn’t seem as if people use it to its potential. For example, I haven’t noticed much in the way of collaborative discussion, which is what I thought this Wiki was meant to achieve.

I’m having a teleconference meeting about it on Thursday, so we’ll see what comes from that. Meantime, this article is a good read and I think it summarises very well the inherent problems with a Wiki that I’ve observed from a distance. I particularly liked these two paragraphs:

“And so the Wiki becomes a dumping ground for fragmented and incomplete files, textual sound-bites and aborted attempts to catalogue. And therein lies the second great failing of Wikis as information repositories – the absence of accessible organization and indexing. Although the basic Wiki functionality includes a simple search facility, there is little to no built in support for indexing or cross-referencing below the page level. There is no reading path made available to newcomers so that they might work from fundamental to more advanced material. Cogent explanation does not result from snippets of conversations; and exchanges of opinion need not be illustrative or informative.

Attempts to collate existing “content” into more substantial portions are easily defeated by the free-for-all editing of others, and further inhibited by the user group’s conflicting notions of the worth of the content and the best means for its explication. Just try and find something when the content, un-indexed, is constantly changing under foot.”

If you’re a technical writer, take the latest Skills and Technologies Survey from WritersUA and help contribute to the body of knowledge about our profession.

I don’t know Amber Simmons, but I sure like the way she writes. A few days ago she published an article of hers—”Reviving Anorexic Web Writing“—on A List Apart.

She has some powerful things to say, although I think that ultimately it all comes down to “knowing your audience”. While she takes issue with the basic elements of good technical writing—chunked writing, bullet points, scan-able headings, and the like—I definitely believe they have a place. But they’re not applicable to every website out there.

She also has some valid points about writing text for use in ALT tags. And I particularly liked her anatomical analogy: “The content is the heart of the website. I can’t build you a body until you give me a heart.” I’ll have to use that sometime soon.