Plans support private notes
Professional | Business | Enterprise |
---|---|---|
Private notes are a useful feature in Document360 that allow project team members and specific reader groups to see content that remains hidden from the general public. These notes can be added to articles in both the Markdown and Advanced WYSIWYG editors, giving you more control over what content is visible to different audiences.
Using private notes
Private notes are ideal for leaving reminders or editorial comments within your article. They are especially useful for:
Asking a team member to double-check information.
Keeping notes for future updates or improvements.
Providing extra context or instructions for other project team members working on the documentation.
NOTE
When readers download an article containing a private note via the Download as PDF option in the Knowledge base site, the private note is not included. However, if the team accounts use their browser's Print/Save as PDF function, the private note will be included in the exported file.
Private notes in the Markdown editor
To add a private note in the Markdown editor:
Click the Private notes icon from the toolbar.
Alternatively, use the following syntax to create a private note:
:::(Internal) (Private notes)
Only visible to team accounts
:::
You can edit both the title (Private notes) and content (Only visible to team accounts) of the private note. You can remove a private note by deleting the corresponding syntax. This will remove the note from both the article and the preview pane. Private notes added in this format will not be visible on the public version of your article but can be accessed by team members.
Delete private note
To remove a Private notes from the article or category page, delete the corresponding syntax from the editor.
Private note in the WYSIWYG editor
Navigate to the desired article in the WYSIWYG editor.
Click the Private note icon from the toolbar.
Click on the private note, and a floating menu will appear with the following options:
Copy () - Click to copy the private note.
Delete () - Click to delete the private note.
Private note in the Advanced WYSIWYG editor
Navigate to the desired article in the Advanced WYSIWYG editor.
Use the slash comment
/Private note
or go to Insert () > Private notes.Click on the private note, and a floating menu will appear with the following options:
Copy () icon - Click on the Copy () icon to copy the private note.
Delete () icon - Click on the delete () icon to delete the private note.
NOTE
Private notes cannot be deleted from a published article or category page. You must first Edit the article first to remove the note.
Visibility settings
Click on the Visibility Settings () icon. A popup window will appear with three options:
All team account: This is the default setting when adding a private note. By default, the toggle is turned on, and the private note appears to all team members added to the project.
Security groups: Click the dropdown arrow to view and select the intended team account groups available in the project. Only these groups can view the private note.
Reader groups: This option applies only in Private and Mixed mode Knowledge Bases. Click the dropdown arrow to view and select the intended reader groups available in the project.
NOTE
Selective visibility settings for private notes are only available in the WYSIWYG and Advanced WYSIWYG editors.
FAQs
What are private notes in Document360?
Private notes are a feature that allows project team members and specific reader groups to see content that remains hidden from the general public.
Can I add private notes in both Markdown and WYSIWYG editors?
Yes, private notes can be added to articles in both the Markdown and Advanced WYSIWYG editors.
How can I delete a private note?
To delete a private note, you need to remove the corresponding syntax in the Markdown editor or use the delete option in the WYSIWYG or Advanced WYSIWYG editors.
Can private notes be visible to all team members?
Yes, by default, private notes are visible to all team members added to the project, but you can adjust visibility settings.
What visibility settings are available for private notes?
In WYSIWYG and Advanced WYSIWYG editors, the visibility settings include options for all team accounts, specific security groups, and reader groups in Private and Mixed mode Knowledge Bases.
Is it possible to edit private notes after they are created?
Yes, you can edit both the title and content of the private note after it has been created.
Do private notes appear in the public version of the article?
No, private notes are not visible in the public version of the article.
Can I use private notes for reminders or editorial comments?
Yes, private notes are ideal for leaving reminders or editorial comments within your article.