From 3d2e658bff18cbf46fa83209f032b22761bb3766 Mon Sep 17 00:00:00 2001
From: Marco Biasini <marco.biasini@unibas.ch>
Date: Mon, 18 Jun 2012 11:43:19 +0200
Subject: [PATCH] documented how to report a problem

---
 modules/doc/users.rst | 20 ++++++++++++++++++++
 modules/index.rst     |  7 ++-----
 2 files changed, 22 insertions(+), 5 deletions(-)
 create mode 100644 modules/doc/users.rst

diff --git a/modules/doc/users.rst b/modules/doc/users.rst
new file mode 100644
index 000000000..a24b4aad0
--- /dev/null
+++ b/modules/doc/users.rst
@@ -0,0 +1,20 @@
+Reporting a Problem
+==============================================================================
+
+
+When you run into a problem in OST or have question regarding it's usage, there 
+are a few things you can do to make the life of people helping you easier. If 
+you follow these simple steps, you will make sure, people understand what you are 
+after and will get a response more quickly.
+
+ * Provide a short explanation of what you tried to accomplish, the result you 
+   were expecting and what you got instead. A good example would be: **I tried 
+   to read the attached PDB file. The file looks clean to me, but OST fails with 
+   the following error: "invalid coordinate on line 4."**
+ * If possible, attach a small script that reproduces the problem.
+ * Include the relevant error message in your report
+ * Include the version of OpenStructure you are using
+ * Specify your operating system
+ * If you compiled OpenStructure manually, also include the version for Qt, 
+   Eigen, Python and Boost.
+ 
diff --git a/modules/index.rst b/modules/index.rst
index 81e6336e4..8e5b6dd42 100644
--- a/modules/index.rst
+++ b/modules/index.rst
@@ -7,6 +7,7 @@ OpenStructure documentation
   
   install
   intro
+  users
   base/generic
   base/base
   geom/geom
@@ -96,14 +97,10 @@ Varia
 
 **Supported File Formats:** :doc:`structure formats<io/structure_formats>` | :doc:`sequence formats <io/sequence_formats>` | :doc:`image formats <io/image_formats>`
 
-
+**Users** :doc:`Reporting a problem <users>`
 Extending OpenStructure
 --------------------------------------------------------------------------------
 
 **Howto:** :doc:`write new modules <newmodule>` | :doc:`integrate third-party tools <external>` | :doc:`logging <base/logging>` | :doc:`instructions for developers <contributing>`
 
 
-
-
-
-  
-- 
GitLab