: What is the best way to collect comments on a draft document that is out for review by stakeholders? Draft technical documents can be reviewed by stakeholders. Stakeholders can be fellow practitioners,

Vote Up Vote Down

GitHub provides an inline comment feature which is pretty neat to facilitate reviews, as well as promote discussion among developers about the content and the comments.

(0)

Vote Up Vote Down

As Chenmunka says, there are many systems that will provide a "place" to review the content. As for the actual process, I think that depends on where you content starts. Is it in MS Word? Then Chenmunka's suggestion is probably the lowest effort and best method. A slightly more "modern" alternative might be Google Docs.

If it's structured (XML/DITA) or web focused (Markdown), then you have a lot more tools to choose from. Many documentation systems come with review mechanisms. The way these mechanisms are implemented vary widely, so be sure to really test them before implementing one (I'm a huge fan of POCs).

Another option is using a staging site. If you're publishing to a knowledge base, wiki, or web CMS, most of them will have some feedback mechanisms built in. If you run a staging site you can use it as a place to review content before that content is published to the live version.

In the end, you need a central place to collect comments. Ideally, this place is very close to the source content, because that's going to be the primary determining factor in how much work it is for you, as the technical writer.

(0)

Vote Up Vote Down

You can use a cloud document system such as Microsoft's Sharepoint or one of the similar competitors.

Publish your document there along with the comment form template and then you can either:

Allow reviewers to complete the form offline and upload their version
to the site
Allow reviewers to complete the form online

With the likes of Sharepoint you can restrict access to stop the reviewers from seeing each other's submissions. This is especially useful if the reviewers are from outside organisations. Or, if allowing online completion you may wish to have just one comment form which all can see.

This is more controllable than, say, putting an editable version of your document online and having reviewers add comments within it. You have a number of received, identifiable comments that can be referenced and audited against as necessary.

(0)