Tag: technical writing reviews

Applying review comments in technical documents

Tuesday 13 May 2008 | technical writing

A lot of the suggestions in this article will depend on how well you know your reviewers.  If it’s their first time reviewing your documents, or you have a professional relationship with them rather than a friendly one, then you may need to compromise on more of the less important matters. Stick to your guns on the ones that you [...]

Comments: 1

Reviewing technical documents

Tuesday 29 April 2008 | technical writing

As mentioned in my post about the technical documentation process, there are two types of review which your technical documents should ideally be put through. Technical Reviews Technical reviews should be done by a subject matter expert (SME) – in other words, someone who knows all about the technical thing you’ve written about. In practice, [...]

Comments: -