Documentation Guide
Breadcrumbs

Backoffice Manual Requests

This page describes the method and procedures for requesting updates to the MG+ Backoffice manual.

To facilitate the writers understanding of the new feature, please include the writer in a meeting (for example, a feature showcase meeting). This will allow the writer to ask questions and start drafting the updates promptly.

Workflow


BO manual workflow.drawio.png

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.

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 the name of your new feature per the title structure:

FeatureNameHere

eg.

Invoice Reports

Components

Ignore this field.

Attachment

Optional

  • Attach any further documentation for context

  • Screenshot attachments. It would be useful if screenshots in all languages are provided

    • Can be all the screenshots showing the UI required for the task for the tech writers reference

    • Or, can be screenshots showing step by step to recreate the “task” that the user is trying to accomplish

Description

☑️

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:

Backoffice Manual (RDOC-8)

Due date

☑️

  • Choose a date that this task has to be completed by (generally this should be at least a day before the GN date for the feature release, and allowing for 2 weeks time for the manual to be worked.)