: Re: 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,
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.
More posts by @Frith254
: Why do many manuals and technical documents seem to prefer passive voice? It seems like many manuals and technical documents prefer passive voice over active voice. Is this true, or is it just
: Using Myers–Briggs as a guide for character development? Edit: I looked at What are some ways to get to know your characters? and while I noticed similarities, I think that question asks in
Terms of Use Privacy policy Contact About Cancellation policy © selfpublishingguru.com2024 All Rights reserved.