.. _documentation_support:

=========================================
Support Documentation for GridUnesp Users
=========================================

.. contents:: In this section:
   :local:
   :depth: 2

.. image:: Figures/documentacao.png
   :alt: Support documentation
   :align: center

Context
=======

The Satisfaction Survey conducted in 2018 with GridUnesp users identified the need for improvements in the support documentation. Based on the feedback received, the team identified the following critical points:

- **Clarity of information**: the need to make the content more accessible for beginner users
- **Practical examples**: demand for more example scripts for different applications
- **FAQ**: the need for a frequently asked questions section
- **Translation**: making documentation available in English as well

Improvements Implemented
========================

Revised Documentation
---------------------

The GridUnesp team started a comprehensive effort to update and revise the documentation:

1. **Complete restructuring** of the content, organized by experience level
2. **New examples** of submission scripts for common applications
3. **Frequently Asked Questions (FAQ) section** with answers to the most common questions
4. **Explanatory diagrams and videos** about how the cluster works

..
  5. **Bilingual version** (Portuguese/English) of the documentation
  
  .. note::
     The revised documentation is available at:
     
     - Portuguese: https://ncc.unesp.br/docs/pt_BR/
     - English: https://ncc.unesp.br/docs/en/

  Upcoming Improvements
  =====================
  
  The GridUnesp team plans to implement the following improvements soon:
  
  Ticket System
  -------------
  
  A ticket system will be deployed to receive and resolve support requests more efficiently, allowing:
  
  - **Tracking** of request status
  - **Complete history** of support cases
  - **Prioritization** of critical demands
  - **Metrics** for response time and satisfaction
  
  Frequently Asked Questions Page
  -------------------------------
  
  A dedicated frequently asked questions page is under development, covering:
  
  - Common access problems
  - Frequent errors in submission scripts
  - Questions about usage policies
  - Guidance on optimizing jobs

Upcoming Improvements
=====================

**New version of the GridUnesp Manual**

- More practical examples of the installed scientific applications
- New information about cluster access and resource management
- More instructions regarding specific problems
- Bilingual version (Portuguese/English) of the documentation

..
  **AI agent for troubleshooting**
  
  - Implementation of AI to instruct users on how to use GridUnesp
  - Direct conversation with an AI agent for troubleshooting jobs
  - Getting help independently of contacting the support team

**Release of a study on job profiles**

- Statistical analysis of job profiles on GridUnesp
- Readjustment of job queues to optimize the use of computational resources
- Improvement in the optimization of job submission scripts
- Guidance on the optimized use of cluster resources

.. seealso::

   - :ref:`faq` - Check before sending questions
   - :ref:`contact` - Support channels
   - :ref:`satisfaction_survey` - Complete survey results