Skip to contentWolf-Rayet

Comment

A comment displays discussions and user feedback.

When to use

  • A discussion attached to something, such as an issue or a document.
  • A thread where who said what and when is part of the meaning.
  • Replies, where nesting shows what answers what.

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, which is a field.
  • Deep nesting. Past one or two levels the indentation runs out and the thread becomes unreadable.

Guidance

Do

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

Give the name, a readable time and the avatar. All three together say who is speaking 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 identifier and a raw timestamp. Neither is written for a person to read.

Content

What to write, and what to leave out.

  • Use the author’s display name, never an internal id.
  • Format the time for a reader. 12 Oct at 09:14, or a relative time for something recent.
  • Name actions by what they do, and keep them to the few that are actually used.