diff --git a/dev-docs/source/UserSupport.rst b/dev-docs/source/UserSupport.rst new file mode 100644 index 0000000000000000000000000000000000000000..95e3342648bbdb7a87564e3648b3374a143aa302 --- /dev/null +++ b/dev-docs/source/UserSupport.rst @@ -0,0 +1,38 @@ +.. _UserSupport: + +============ +User Support +============ + +.. contents:: + :local: + +Introduction +############ + +As Mantid continues to facilitate cutting-edge scientific research, for an +increasing number of users, the support side of Mantid is growing more +and more important. This can be in many circumstances and through +different avenues; therefore, below is detailed our support procedures. + +The main purpose of user support for the Mantid project, is to aide contact between the users and developers. + +.. figure:: images/errorReporter.png + :class: screenshot + :width: 700px + :align: right + :alt: Error reporter + + *Error reporter sends details directly to Mantid support* + +Bugs and Error Reports +---------------------- + +1. Users can report bugs via the `Mantid Help Forum <https://forum.mantidproject.org/>`_ or the `Mantid Help Email <mantid-help@mantidproject.org>`_, or from collected **Error Reports**. Currently this is a quick first contact with the team, but doesn't give much detail about the usage or unexpected error. +2. The bug is verified and reproduced by the support team. +3. The impact and importance is assessed by the support team member by contacting the users, instrument scientists, developers or project manager as appropriate. +4. A GitHub issue to resolve the problem is created if appropriate and/or workaround tested if possible. +5. The user is contacted to give a link to the created issue and/or workaround solution, by the support team. +6. When any issue is completed naming a user, that user is contacted to let them know it will be available in the nightly build and next release. The gatekeeper that merges the fix should message the appropriate developer, to remind them to contact the original reporter. This could simply be through adding a comment while merging that points this out. + + diff --git a/dev-docs/source/images/errorReporter.png b/dev-docs/source/images/errorReporter.png new file mode 100644 index 0000000000000000000000000000000000000000..db44632ba3d945510058c4fbf84bec27f280acb6 Binary files /dev/null and b/dev-docs/source/images/errorReporter.png differ diff --git a/dev-docs/source/index.rst b/dev-docs/source/index.rst index 4b08860b473cfa6ea5b2041b9c67036ba76233b8..8c43f6fb93a35abb7ab04da79d05039f1a43131c 100644 --- a/dev-docs/source/index.rst +++ b/dev-docs/source/index.rst @@ -62,6 +62,7 @@ Development Process DevelopmentAndReleaseCycle Communication IssueTracking + UserSupport GitWorkflow AutomatedBuildProcess JenkinsConfiguration @@ -79,6 +80,9 @@ Development Process :doc:`IssueTracking` Describes how issues are tracked over the project. +:doc:`UserSupport` + Procedures for User Problems to be tested and passed to the Development Team. + :doc:`GitWorkflow` Details the workflow used development with git and GitHub.