merchantla.blogg.se - How to use confluence in a sentence

Inline comments are suitable for small groups of collaborators during the content drafting phase, and can be used to gain feedback on specific sections of text before the content is published. And technical writers – such as the Atlassian team – benefit from this concise way of referring and responding to questions. Threaded comments, in a separate section below the page content, provide a more structured way for readers to interact and provide feedback. These groups typically consist of one or two experts, plus a technical editor in most cases.Īs a rule, the ‘old-fashioned’ comments system remains the best way to keep pages clutter-free and avoid confusing casual readers. It is most effective for smaller groups during the drafting phase.

Confluence’s inline commenting feature was not designed for use by large audiences.

Visible inline comments can significantly impact readability.

New visitors to the pages could be confused if help content contains extensive orange mark-up.

If you browse any public-facing Confluence pages, you’ll notice that inline comments are still disabled, even though the site runs with Confluence 5.7+. Feedback Loop on Public Documentation Sites Inline comments provide a real boost to productivity for (small) teams who need to discuss a documentation page while it’s under construction. This fun, one-click solution allows users to add their comments while viewing the relevant section of text – eliminating the need to scroll down to the comments section. Once you’ve added your feedback, you can resolve comments simply by clicking ‘Resolve’. The inline comments functionality allows users to review Confluence pages line by line and add comments on selected words, phrases, or entire paragraphs. Here’s a wrap-up of that discussion – plus some best practices for using inline comments or choosing (threaded) page comments in Confluence. The entire Confluence user community – including ourselves here at K15t Software – instantly fell in love with this new way to close the content feedback loop.īut can inline comments be used for questions and feedback on public documentation sites? Or are comment threads below pages still the best way to interact? This key issue was discussed on the Atlassian Confluence documentation site. Confluence 5.7 was the first release to boast inline comment functionality.