Skip to contentWolf-Rayet

Comment

A comment shows discussion and feedback from users.

When to use

  • A discussion attached to something, such as an issue or a document.
  • A thread where it matters who said what, and when.
  • Replies, where nesting shows which comment each one answers.

When not to use

  • System messages or an audit trail. Those are not comments and should not look like people talking.
  • A single note with no discussion. Use a field.
  • Deep nesting. After one or two levels there is no room left to indent, and the thread is hard to read.

Guidance

Do

AM
Ava Mensah12 Oct at 09:14
Moving this to billing. They own the refund policy.

Show the name, a readable time and the avatar. Together they show who wrote it and when.

Don't

user_48212026-10-12T09:14:22.431Z
Moving this to billing. They own the refund policy.

Do not show an internal ID or a raw timestamp. Neither is meant for people to read.

Content

What to write, and what to leave out.

  • Use the author’s display name, never an internal id.
  • Format the time so it is easy to read. 12 Oct at 09:14, or a relative time for something recent.
  • Name actions by what they do, and only include the ones people use.