Technical Writing Archives - Page 5 of 17

Choosing a Documentation Tool…Part 1

For many years, I have worked with hi-tech companies, creating their documentation and/or online help using a variety of industry-standard tools. In recent weeks, two companies have asked me to help evaluate their current and expected future needs to determine the best tool for them. In each case, I created an extensive presentation with the following sections: Goal (Part 2) Current Situation (Part 3) Requirements (Part 4) Options (Part 5) - Coming soon Costs (Part 6) - Coming soon Recommendation (Part 7) - Coming soon…

Comments Off

April 17, 2013

Technical Writing / Writing

Estimating the Impossible

Earlier today, I had a very enjoyable conversation with an Israeli company that works primarily in Africa. They want to hire WritePoint to write a document, one of many, we hope. The person with whom I spoke is new to the company and wants to improve the existing documentation. Amazingly enough, perhaps even close to unique, he isn't in a rush. There are no firm deadlines - just a lot of documentation that he calls "Hebrew written in…

4 Comments

September 12, 2012

Technical Writing / Training Courses

Olim and Technical Writing

Once upon a time, a company put out an advertisement that lasted all of 5 minutes before it was ridiculed out of existence. The ad said, "If you speak English, you can be a technical writer." There is so much more to being a technical writer than needing a high level of English. Yes, if you plan to write in English, your level of English must not only be mother-tongue, but perhaps even higher. You have to have…

6 Comments

September 10, 2012

Technical Writing / Uncategorized / Writing

Is Editing a Document Enough?

I can't tell you how many times a company has come to me and said they have an editing job for us. The content is there, they explain, it's just a matter of editing it. Last week, a client came with this exact comment. Now, there are times when the client genuinely means this. Editing IS enough. Perhaps it is an internal document - one that will be passed around within the company. The expected audience knows the…

2 Comments

August 29, 2012