Docsalot home pagelight logo
  1. Creating Documenation
  2. Comments and collaboration

​
Comments and collaboration

Comments let you leave notes on specific pages so other people on your team can see what needs attention and pick the work up. Use them to hand off edits, ask questions, or flag content that needs review, without having to message people separately.

​
When to use comments

Comments work well when you want to:

  • Flag a problem: Point out outdated, unclear, or incorrect content on a page.
  • Request an edit: Describe a change you’d like made and leave it for a teammate to complete.
  • Ask a question: Check a detail with the page’s owner before you change it.
  • Hand off unfinished work: Leave context on a draft so someone else can continue it.

​
Leave a comment

1

Open the page

Go to Dashboard → Documentation and open the page you want to comment on.

2

Add your comment

Write your note on the page. Be specific about what needs to change and why, so whoever picks it up doesn’t have to guess.

3

Let your team know

Teammates with access to the documentation can see the comment the next time they open the page.

​
Work on a comment

When you open a page that has comments on it:

  1. Read the comment and any replies for context.
  2. Make the requested change in the editor. See Create and edit pages for editing in visual or Markdown mode.
  3. Reply or update the comment so others can see the work has been done.
  4. Publish your changes when you’re ready for them to go live.

​
Tips for useful comments

Be specific

Say exactly what needs to change, and point to the section or sentence it applies to.

Explain the why

A short reason helps the next person make the right call.

One topic per comment

Keep each comment focused on a single issue so it’s easy to complete.

Follow up

Reply when work is done so teammates know which comments still need attention.

Comments are visible to your team inside the editor. They are not shown to readers of your published documentation.