Monthly Archives: December 2013

How I Write and Edit 2

The biggest challenge when I have to edit a large chunk of documentation involves retaining a singular voice. Sometimes I prefer to write content from scratch, but quite often, I must edit existing documentation due to product enhancements. This type of editing lets me take my from scratch approach, especially if I am modernizing the documentation to read more like an article.

The most important aspect of technical communication involves understanding your customer’s role. As technical writers, we sometimes make assumptions about the user’s domain knowledge. We cannot make these assumptions unless we really know our customer base. Some customers simply need to have their hand held with certain concepts, especially with configuring complex environments. These environments have so many prerequisites that it can make your head spin, but that is why we collaborate with developers and testers to implement best practice content in our documentation.