Commit 726cd08a authored by Kirsty Allen's avatar Kirsty Allen 📚
Browse files

Changed the workflow details

parent 687539dd
Loading
Loading
Loading
Loading
+8 −37
Original line number Diff line number Diff line
@@ -11,48 +11,19 @@ Before creating a new article, search the existing knowledge articles to make su

- Draft article is created (using a template)
- Knowledge Article is `In Progress`
- The Knowledge Team then reviews the article for accuracy. (Is the formatting correct, are there any spelling errors, do the links work?)
- The article is then ready to be "Reviewed" by a "Technical Reviewer". (assign the article to a technical reviewer and move to `Awaiting Review`)
- The article is `Published`

{{% alert title="Note" color="primary" %}}

- When creating the knowledge article it should always be in `In Progress` status.
- `Awaiting Review` status will be used when assigning to a Technical Reviewer.
- `Ready to Publish` status will be used for articles that are reviewed and ready to be published on a specific date (Example: articles set for product releases)

{{% /alert %}}
- The article is then ready to be "Reviewed" by a "Technical Reviewer". (assign the article to a technical reviewer)
- The article is `Published` (Merged)

## Modify a Knowledge article

- Article is in **Edit** status (draft).
- Knowledge Article is `in Progress`.
- Save the article.
- Articles should always be reviewed. Is the content still accurate? Are the links going to the right location?
- Knowledge Article is updated (in sync repo)
- The article is then ready to be "Reviewed" by a "Technical Reviewer" (only if major changes. Minor changes it can be Republished).
- The article is `Published`.

{{% alert title="Note" color="primary" %}}
When modifying a knowledge article, the article goes back to `Draft`. The current version of the article will remain active on the page. When the draft is published with updates, it will update the page.
{{% /alert %}}
- The article is `Published` (Merged)

## Approving and Publishing a Knowledge article

- Article is `Awaiting Review` or `Ready to Publish` status.
- Technical review must be done on the article.
- If changes need to be made, use the **Assign to** (Round Circle icon near the title). Add comments and assign to the author to make changes.
- Save the article.
- Ensure the visibility of the article is correct.
  - `Agent and Admins` means it is a private article, visible only to internal team members.
  - `Everyone` means it is public.
- If the article is ready to publish, choose the **Publish** button. (Use the down arrow next to the Save button)
- The article is `Published`.

{{% alert title="Note" color="primary" %}}
See the [Publishing Training](/handbook/support/knowledge-base/knowledge-base-training/) for more help.
{{% /alert %}}

The following workflow diagrams are available:

- [Creating a Knowledge article Workflow](https://drive.google.com/file/d/1cAuZTKSPETCBgyUFoU_nCv2Otf3mcn-B/view?usp=sharing)
- [Modifying a Knowledge article](https://drive.google.com/file/d/1CiiSCe1Q0Sk02j_6DN5OrJtFKErmiIkq/view?usp=sharing)
- [Publishing a Knowledge Article](https://drive.google.com/file/d/19rqHBGOU71_1oxP7H28lUYWxXPKVjWbU/view?usp=sharing)
- If changes need to be made, alert the article author (assign to them in the MR)
- Once the article is updated, the article can be ready for publish
- The article is `Published` (Merged)