Documentation Guide
Breadcrumbs

Other Documentation Requests

The aim of this procedure is to provide instructions on how to submit tasks for updating existing content, requesting corrections, and adding new content to be written about.

Timing estimation: 2 weeks.

How to log the Jira ticket

  1. Access the Jira board.

  2. Click the Create button. A Create issue page will pop up.

  3. Fill in the fields per the instructions below. Once you’re done with the form, click Create and your task will follow the workflow process.

  4. In order to convey your desired modifications effectively you could:

    1. Attach a link to a wireframe (eg. an Overflow/Figma board) including the password for more context.

    2. Attach screenshots of a mockup of the page.

    3. Paste links to relevant Confluence pages in the description section of the Create issue form.

Field

Required?

Notes

Project

☑️

Ensure that RCT Documentation (RDOC) is selected from the drop down menu.

Issue type

☑️

Choose Story from the drop down menu.

Status

☑️

Ensure that Backlog is selected from the drop down menu.

Summary

☑️

Fill in this field with a short description of what needs to be changed.

Components

Ignore this field.

Attachment

Optional

  • Attach any further documentation for context

  • Screenshots

    • Any screenshots for context.

Description

☑️

Examples on what to write in the description:

  • What the feature is used for.

  • What you want to correct.

  • General explanation of the steps to recreate the “task” you want the user to accomplish, if any.

  • Any Confluence links to other pages that may have more documentation on the feature.

Reporter

☑️

The submitter for the task and the main contact person.

Linked issues

Ignore this field.

Fix versions

Ignore this field.

Assignee

Ignore this field.

Priority

Ignore this field.

Labels

Ignore this field.

Epic Link

Ignore this field.

Parent

☑️

Select the Parent link:

Other Documentation (RDOC-34)

Due date

☑️

  • Choose a date that this task has to be completed by (Must be at least longer than 1 week)