How to Submit a Ticket for API Documentation

The MG+ API Documentation Site is a hub of all our guides to help operators in utilizing our APIs. It is separate from the API Dev Portal, which acts as a reference for the API endpoints.

For updates to the API Dev Portal, please refer to this section.

Each guide is maintained across a variety of teams. Documentation’s role consists of:

Working with the document owner to create new guides
- This could include new quick start guides, how-to guides and FAQ’s
Executing requests to rephrase content in existing guides to make it more clear per the document owners request
Adding new content to existing guides per the request of the documentation owner
Grammar updates

Requests regarding content updates must first be communicated to the document’s owner. Therefore, please communicate your requested updates to the Document Owner first about your suggested changes, and come to an agreement about the changes prior to submitting a ticket on their behalf. The process for the ticket reporter are as follows:

Create the RDOC Jira ticket.
Giving context for what exactly needs to be done in the task.
Reviewing the drafts attached to the ticket. The technical writer will leave a note in the ticket to let them know when a draft is ready for review in the comments section.
Letting the technical writer know if the draft is approved.

How to log the Jira ticket (Document Owners Only)

Example of a Jira Ticket - https://bigasiajira.atlassian.net/browse/RDOC-49

Access the Jira board.
Click the Create button. A Create issue page will pop up.
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 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	☑️	Describe your request. Please provide as much context as possible in order to expedite the writing process.
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: API Documentation (RDOC-54)
Due date	☑️	Choose a date that this task has to be completed by (Must be at least longer than 2 weeks)