Talk Inline Comments: Reviewing Documents
With this post we start publishing a series of use cases that will demonstrate all features of Talk Inline Comments add-on for Conlfuence in a real-life situations.
The Talk add-on is great for reviewing any kind of content in Confluence, since unlike standard Confluence comments, it provides an easy to way to see what part of a page is being commented. Reviewing content with standard Confluence comments requires you to provide a context. With Talk, context is always right before you. Let’s see how a reviewing process looks for one of our customers. They are software developers and use Talk for reviewing documentation they create for their software.
John creates documentation in Confluence for a product developed by Peter and Julia. All three report to Mark who is responsible for a final review and communication with a customer representative – Troy. Troy also has access to Confluence and can view and edit pages.
Sometimes when working on documentation John needs to ask Peter and Julia whether he expressed some idea clearly and correctly in his text. In this case John inserts a new discussion next to a problem in the document and addresses Peter and Julia with mentions.
Once they’re mentioned in a comment, Peter and Julia get both Workbox and email notification, so they can just click a link in an email and jump directly to John’s question.
The Talk icon in the text help them to understand the context, so they can add their comments to the discussion and answer John’s question.
When a problem is solved, John applies changes to his manual and resolves the discussion.
Sometimes Peter and Julia find some bugs in documentation and bring them to John’s attention by posting a comment. In this case, they resolve discussions when the bug is fixed.
Finally, the document is shared with Mark for a final review. He can ask someone (or everyone) a question mentioning people to get a prompt response.
Up to this point all Talk discussions were hidden from Troy with the Talk permission management functionality, since some of the questions are better to solve privately within a team. In case Mark wants to involve Troy into discussing some issues in the content, he can always make a discussion thread visible to him in the discussion settings.
Troy can also start discussions, and since all discussions are visible to their creator by default he can later add new comments to the discussion he started. Once Troy is happy with the documentation, discussions are removed and Mark makes the documentation visible to anonymous users, that is customers who don’t have access to Confluence.