Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/src/further_topics/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,5 @@ Extra information on specific technical issues.
dask_best_practices/index
ugrid/index
which_regridder_to_use
controlling_merge
controlling_merge
ux_guide
50 changes: 50 additions & 0 deletions docs/src/further_topics/ux_guide.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
.. _ux_guide:

Reviewing the Iris User Experience
**********************************

.. todo:: https://github.com/SciTools/iris/issues/6511; this page belongs in 'Explanation'

Often, improving and updating the existing user experience can fall behind fixing create new features,
or quashing pesky bugs. To combat this, we plan to have regular development discussions to ensure
UX doesn't fall behind. These pages offer some insight into what sort of things we might be discussing,
and hopefully offers some extra transparency behind our development process.

Below are some potential topics to guide future discussions on the Iris user experience.

.. note::

If you have any thoughts or comments on either the user experience of Iris, or on this page,
please create a GitHub discussion, or comment in an existing one
(`See our UX discussion! <https://github.com/SciTools/iris/discussions/6594>`__)!

We'd love to hear from you!


Topics
======

* **Community**

* How do we make it easy for our users to contribute, ask questions, and generally get involved?

* **Documentation**

* How accessible and complete is Iris' documentation?

* How easy is it to move from Iris to another package, including those within
SciTools and external packages?

* How transparent are our philosophy, past development decisions, and future plans?

* **Codebase**

* How aligned is Iris with other packages in the wider community? e.g. common api, common jargon

* How easy is it for users to debug and diagnose code?

* Is the API as simple as possible for users to understand and access?

* **Culture**

* Are there any procedures or habits that our developers should introduce/change?
17 changes: 17 additions & 0 deletions docs/src/userguide/iris_philosophy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -189,3 +189,20 @@ Examples of Iris Warnings
expected.

.. _ecCodes: https://github.com/ecmwf/eccodes

Planning Procedures
===================

Planning procedures encompass some of the methods Iris' core developers make
decisions about how and what changes are made to Iris, and how we go about
prioritising these.

User Experience
---------------

Often, improving and updating the existing user experience can fall behind fixing create new features,
or quashing pesky bugs. To combat this, we plan to have regular development discussions to ensure
UX doesn't fall behind. These pages offer some insight into what sort of things we might be discussing,
and hopefully offers some extra transparency behind our development process.

See our more detailed page here: :ref:`ux_guide`.
Loading