Documentia Inc. is your one-stop shop for your technical documentation needs. Our writers specialize in writing, designing, researching, and developing user documentation that is tailored to your specific industry and user needs.
Click here to see the LinkedIn profile for Documentia Inc..
Documentia Inc. Blog by John David Hickey is licensed under a Creative Commons Attribution-NoDerivs 3.0 Unported License.
Based on a work at www.documentia.ca.
Author Archives: jdhickey
Writing is like building a house in the woods where no house previously existed. Re-writing is like demolishing a house in the woods and rebuilding it to suit your needs and stylish flair. Editing is like: inspecting every door and … Continue reading
Reading technical documentation is nobody’s idea of an enjoyable night in. You could try to make it special with some wine and candlelight, but it’s still going to be a stretch. Therefore, the documentation needs to strike that balance between … Continue reading
So I have been having to sit on this for about a week, but now I’m allowed to show it off. Here’s the story. In mid-December, I was contacted by an office furniture-design company in the Montreal area called Group … Continue reading
I was looking up some stories and I came across this Islamic folktale: – The following is an incident about an engine failure in a giant ship. The ship’s owners tried one expert after another, but none of them could … Continue reading
When you are working with people, either as a co-worker or as a manager, and you have someone explaining something to you that either you don’t understand or you think is outlandish, you need to hide these emotions from your … Continue reading
I’ve always known that Weird Al was somehow spying on my life. I now have proof.
Years ago (in the mid-1990′s I think), I was doing a contract for a client that developed their own touch-screen technology for the food service industry. I had submitted a draft of the documentation for review to a client with … Continue reading
While reviewing a technical document, I found a most humorous typo: suedo-code. Unless the code is actually made of suede, I’m going to assume the author meant Pseudocode. I posted about this typo on my Facebook page and hilarity ensued: … Continue reading
Just in case any of you go crazy and decide to be Technical Writers, let me impart this nugget of wisdom: when writing instructions, be aware that users PRESS keys on a keyboard and they CLICK buttons on the interface. … Continue reading