Category Archives: Tech writer tips

Creating headers in Ditamaps

I found it difficult to find relevant information on the web about how to create anything below a level-heading 2. In my Ditamaps the heading 2 is the topic level and therefore, as soon as a topic is added to … Continue reading

Posted in DITA, Tech writer tips, Usability studies | Tagged , , , , , , , | Leave a comment

Shall vs. Will

In an earlier post, one in which I was trying to be funny, I mentioned shall or indeed, shalt, as a sign that god was a technical writer. But, when do you use shall or will? What is the difference? … Continue reading

Posted in Style Guide, Tech writer tips, Usability studies | Tagged , , , , , , , , , , , , , | Leave a comment

Machiavelli for tech writers

  Tina the tech writer could have done with a bit less passive aggression and a bit more canniness. The muttering, grumbling tech writer who is forever being overruled touches a chord with a lot of people in our profession. … Continue reading

Posted in Tech writer tips | Tagged , , , , , , , , , , | Leave a comment

Scientific metaphors

  We don’t use metaphors in technical writing, or at least we don’t think we do. But, are we using dead metaphors? There is a very interesting radio programme on BBC about scientific metaphors and their usage (in fact this whole … Continue reading

Posted in Tech writer tips, Usability studies | Tagged , , , , , , , , , , , , , | Leave a comment

Editing: read aloud

When editing and reviewing your own content or someone else’s, there is one tip I can give which I think surpasses all others: read aloud! Spoken word is much older than the written word and it is the rhythms of … Continue reading

Posted in Tech writer tips, Usability studies | Tagged , , , , , , , , , | Leave a comment

Language use: act like a baby and treat others like one too

Maybe it seems like I am being puerile with the title or going to mention something about always using the lowest common denominator when thinking of your audience. But, not at all; the opposite in fact. It’s in infancy when … Continue reading

Posted in Style Guide, Tech writer tips, Usability studies | Tagged , , , , , , , , , , , , , , | Leave a comment

Creating a new style

So, you now know you have at least two styles that you want to create. How do you go about implementing them? How do you document your styles and keep track that styles are being used correctly? If you have … Continue reading

Posted in Style Guide, Tech writer tips, Usability studies | Tagged , , , , , , , , | Leave a comment