wordbit logo
wordbit random header image

Entries Tagged as 'documentation'

DocTrain Day 1 – Simplified Technical English

May 7th, 2008 · Comments Off

Today I attended a pre-conference workshop on Simplified Technical English (STE) at DocTrain West. Berry Braster, director of Tedopres, presented the benefits of writing documentation using standardized, unambiguous English, especially when materials are being translated into other languages. The implementation of STE involves developing a company-specific dictionary and using documentation software to aid in the […]

Tags: conference · DocTrain West 2008 · documentation · productivity · technical writing

Content Convergence & Integration 2008

March 13th, 2008 · Comments Off

 This conference kicked off in Vancouver today and is the place to be if you’re facing content management issues in your professional life as a technical writer, or if you want to stay on the leading edge of developments in the field. Each day has a specific theme. Day 1 (today) is about content, day […]

Tags: cci2008 · documentation · events · productivity · technical writing

It’s your English – fight for it!

March 11th, 2007 · Comments Off

There is nothing more sickening than a piece of writing bloated and weighed down by heavy jargon and confusing language. Call it what you will – jargoneze, legalize, bureaucrateze, or just plain gobbledygook. If you’re spreading this kind of rot, you’re a language killer and should be tried and condemned by your peers as such.

Tags: documentation · technical writing · writing

Cultural sensitivity in user documentation

February 28th, 2007 · Comments Off

When editing technical documents, how aware should you be of regional differences in pronunciation? Here is an interesting article on the subject by Brian Forte. Forte raises the following issue regarding the usage of an indefinite article with initialisms: How do you pronounce an initialism like HTML? I was taught English in public Australian schools […]

Tags: culture · documentation · editing · grammar · technical writing