Document Change Requests
Document Change Requests (DCRs) provide a formal, traceable process for requesting modifications to released documents. Instead of directly editing a released document, submit a change request that describes the proposed change, its rationale, and expected impact.
When to use a change request
Section titled “When to use a change request”Use the Document Change Request process when:
- A released document needs content updates or corrections.
- A regulatory or process change requires document modifications.
- An error or inaccuracy is discovered in a released document.
- A user identifies an improvement to an existing document.
Submit a change request
Section titled “Submit a change request”- On the left sidebar, select Documents.
- Select the document you want to request changes for.
- On the document detail page, select Request Change to open the Request Document Change modal.
- In the Request Title field, enter a brief summary of the requested change.
- In the Description field, enter a detailed explanation, including the rationale and expected impact.
- Select Submit Request.
- The modal closes and the page refreshes to reflect the new request.
Form fields reference
Section titled “Form fields reference”| Field | Required | Description |
|---|---|---|
| Request Title | Yes | A brief summary of the requested change. |
| Description | Yes | A detailed explanation including rationale and expected impact. |
Validation rules
Section titled “Validation rules”- The Submit Request button remains disabled until both the title and description fields contain text.
- If the API returns an error, an error alert appears within the modal with the specific message.
Handle a failed submission
Section titled “Handle a failed submission”If the change request submission fails:
- Review the error message at the top of the modal form.
- Correct the issue and select Submit Request again. Your entered data is preserved.
- To discard the request, select Cancel or the close button.
Permissions
Section titled “Permissions”| Action | Requirement |
|---|---|
| Submit a change request | Authenticated user with access to the document |
| View change requests | Authenticated user with access to the document |