Tips for Writing Known Issue Articles

Your Known Issue articles should all follow a similar structure, made up of a title and text. 

Article Title

Your title should be a brief description of the issue. We recommend adding the date before the title to help customers and team members easily see when you opened the issue.
For example: 30 August, 2019 - Unable to Edit Text

Article Text

You can decide if you want to use the same text for all of your Known Issues or change the text for each issue.

Include one or more of the following sections in your Known Issue:

  • A sentence stating that you are aware of the issue and you're collecting more information, or working on it.
  • An invitation to report that you're experiencing this issue by clicking the button at the bottom of the page.
  • An explanation of what can be done in the meantime (e.g., a workaround), if possible.