Technical Document Review - Microsoft Word is Not a Review Tool

In many development organizations, software developers use Microsoft Word to communicate and gain consensus on important information, such as requirements, specifications, test and validation plans, and marketing collateral. Critical to project success and the customer validation of product requirements, these technical documents are shared with other project stakeholders—product managers, engineers, project managers, marketing staff, and support and QA professionals—who edit, annotate and send document versions to each other for feedback. Making these documents available to colleagues and requesting feedback is a necessary step to ensure that the team knows what they are building. And sometimes you feel like the guy in the picture.

Anyone in development can tell you that at least a few requirements will be changed during the course of the development phase. When these changes occur, it becomes even more important for stakeholders to review them and understand the scope and ramifications of those changes. Whether you use waterfall or more Agile methodologies, requirements drive development effort and shape the final result. So reviewing these documents early and often throughout the coding phase is critical to everyone being on the same page, and delivering valuable software.

There are only a few ways, however, to share and solicit technical document feedback. If you are not scheduling formal inspection meetings or using a document management system (which forces you to review serially), then you are likely using Microsoft Word to create these documents and artifacts and email to distribute them to team members. In this quite typical situation, development teams rely on Microsoft Word as both a document authoring tool AND a document review tool. Their challenge is that Word was designed as a document authoring tool, not a review tool. Because the document editing process is not centrally managed in Word, document authors need to navigate through tedious email feedback. This process is not only confusing in larger teams, but it can lead to significant mayhem – especially when critical feedback is overlooked, contradicted, or even ignored.

Because Collaborator is purpose-built for document review, it simplifies the review process, eliminates lengthy email trails, and ensures compliance with electronic signatures. Let’s take a closer look at how Collaborator accomplishes these goals.

Document Review, The Problems with Using Microsoft Word

Document Review Using Microsoft Word

  • Reviewers may edit outdated document versions
  • Reviwers can't see each other's comments (unless they check in/out doc and modify only one, centrally stored doc), and authors can’t see all the comments in one place)
  • Emails cross, causing overlapping threads and confusion
  • Review meetings that gather the team together are challenging to schedule
  • Comments are deleted and lost
  • Microsoft Word does not gather metrics
  • Lacks inherent document “sign-off”
  • Documents in email can be accidentally forwarded to the wrong party

Document Review Using Collaborator

  • Documents are centrally managed. All reviewers see the exact same, always current document
  • Reviewers use threaded contextual chats and can see each other’s comments in real-time
  • There are no emails to cross. All threads are maintained in one place
  • Teams can review documents synchronously or asynchronously. Meetings are not required.
  • Comments are permanently logged. Defects are tracked through resolution.
  • Collaborator gathers metrics automatically
  • Enables electronic signatures for key stakeholder document sign-off
  • Documents can be downloaded and forwarded in email, but not accidentally

Learn more about Collaborator. Collaborator makes the document review process easier and faster and ensures that all comments are preserved in one location.  Meeting regulatory and compliance mandates just got easier with Collaborator’s unique document review and electronic signature capabilities.

peercodereview-best-kept-secrets-wp-cta


Close

By submitting this form, you agree to our
Terms of Use and Privacy Policy

Thanks for Subscribing

Keep an eye on your inbox for more great content.

Continue Reading

Add a little SmartBear to your life

Stay on top of your Software game with the latest developer tips, best practices and news, delivered straight to your inbox