Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Principles

The principles for developing SDP help articles

Rw ui textbox macro
typeinfo

We follow the Style Manual for SDP help articles. When content is technical and requires step-by-step instructions

We follow the Microsoft Style Guide for SDP help articles.

Find out how your knowledge base articles are performing | Jira Service Management Cloud | Atlassian Support

UI text box

Rw ui textbox macro
typesuccess

UI text box type = success

Rw ui textbox macro
typesuccess

UI text box type = success

Rw ui textbox macro
typewarning

UI text box type = warning

Rw ui textbox macro
typeerror

UI text box type = error

Rw ui textbox macro
typenote

UI text box type = note

Rw ui textbox macro
typetip

UI text box type = tip

Info

Accessibility requirements go in a blue box with an [i]

Tip

Best practice tips or CMS tricks go in a green box with a tick icon

Warning

What not to do go in a red box with a cross icon

Step-by-

Rw ui steps macro
Rw step

Use ShareX to capture screen shots (open-source screen capture tool available in the Microsoft Store)

Image Removed

Rw step

Use the default red square to highlight your step

Rw step

Use the blur function to remove any unnecessary or identifying information