Skip to content
This repository was archived by the owner on Oct 2, 2025. It is now read-only.

Commit 4a5fa3d

Browse files
update developer assistance notes
1 parent 5159b71 commit 4a5fa3d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

sphinx/processes/support_guidelines.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,11 @@ You are not expected to know everything\! Please ask for help whenever you are u
8080

8181
## Requesting Developer Assistance
8282

83-
Sometimes, an issue is a confirmed bug, feature request, or a data move or update that requires code changes to resolve. Once you've exhausted other troubleshooting options and confirmed the need for development work, here is the process for escalating:
84-
85-
1. **Consolidate Your Findings:** Gather all the information you've collected, including the bug report or feature request, steps to reproduce, screenshots, and any relevant details from your investigation.
86-
2. **Assess the Impact:** Prepare a brief summary that includes the perceived severity of the issue. Consider these questions:
87-
* **From the user's perspective:** How critical is this for their workflow? Is it a minor annoyance or does it block them completely?
88-
* **From our perspective:** Does this issue affect a single user, a whole institution, or all users? Is there a viable workaround they can use in the meantime?
89-
3. **Contact the Lead Developer:** Send the complete summary and supporting materials to our lead developer, **[Caroline Denis](mailto:caroline.denis@specifysoftware.org)**, via Slack. She will assess the request's priority and determine when developer resources can be assigned to it.
90-
4. **Communicate with the User:** Once Caroline provides feedback on the timeline, relay this information back to the user. Let them know when they can expect a resolution, whether it's in the next patch or a future major release. Keeping them informed is key to managing their expectations.
83+
When an issue is a confirmed bug, a complex data update, or a feature request that requires code changes, it needs to be escalated for development. Once you have exhausted other troubleshooting options and confirmed the need for developer intervention, please follow this process:
84+
85+
1. **Consolidate Your Findings:** Gather all the information you've collected into a single summary. This must include the original user report, a link to the bug/feature ticket, steps to reproduce, screenshots, crash reports, and any relevant details from your investigation.
86+
2. **Assess the Impact:** Prepare a brief analysis of the issue's severity. Your summary should answer:
87+
* **User Perspective:** How critical is this for their workflow? Is it a minor annoyance or does it block them completely? Is there a workaround?
88+
* **SCC Perspective:** Does this issue affect a single user, an entire institution, or all users?
89+
3. **Escalate for Tasking:** Send the complete summary and support materials to the Technical Support Manager (Grant). He will review the materials, create a formal task in our project management system (Asana), and assign it to the IT Support developer for development and resolution.
90+
4. **Communicate with the User:** Once the task has been prioritized, relay the expected timeline for a resolution back to the user. Keep them informed of any significant progress or changes.

0 commit comments

Comments
 (0)