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.

Leave a comment

Your email address will not be published. Required fields are marked *

2 thoughts on “How I Write and Edit

  • Google

    Hi, I do believe your site may be having web browser compatibility issues.
    Whenever I look at your website in Safari, it looks fine but when opening in Internet Explorer, it has
    some overlapping issues. I just wanted to provide you with a quick heads up!
    Other than that, fantastic blog!

    • pwoz91 Post author

      Thank you for the feedback! I apologize for the long delay. Which version of IE were you using? I updated the themes and plugins on my blog, and it looks the same for me on all current versions of IE, Firefox, Safari, and Chrome, so I am hoping it was an issue with the theme.