Development:Moodle User Interface Guidelines: Difference between revisions

From MoodleDocs
mNo edit summary
Line 28: Line 28:
** [[Development:Checkbox|Checkbox]]
** [[Development:Checkbox|Checkbox]]
** [[Development:Dropdown Lists|Dropdown lists]] (incomplete)
** [[Development:Dropdown Lists|Dropdown lists]] (incomplete)
== General design guidelines ==
* [[Development:Progressive Disclosure|Progressive Disclosure]]
* [[Development:User Data Always Safe|User Data Always (Always) Safe]]
* Feedback
** See [http://mahara.org/view/view.php?id=3482 presentation] ([http://mahara.org/artefact/file/download.php?file=14278&view=3482 alternate link]) of workshop by David Mudrak for the future direction of feedback
** GNOME: [http://library.gnome.org/devel/hig-book/stable/feedback.html.en Feedback]
*** (for Desktop but still a great guide and mostly applicable to Moodle)
=== Relevant guidelines from other sites ===
* [http://library.gnome.org/devel/hig-book/stable/principles-people.html.en Design for People]
* [http://library.gnome.org/devel/hig-book/stable/principles-broad-userbase.html.en Don't Limit Your User Base]
* [http://library.gnome.org/devel/hig-book/stable/principles-match.html.en Create a Match Between Your Application and the Real World]
* [http://library.gnome.org/devel/hig-book/stable/principles-consistency.html.en Make Your Application Consistent]
* [http://library.gnome.org/devel/hig-book/stable/principles-feedback.html.en Keep the User Informed]
* [http://library.gnome.org/devel/hig-book/stable/principles-simplicity.html.en Keep It Simple and Pretty]
* [http://library.gnome.org/devel/hig-book/stable/principles-user-control.html.en Put the User in Control]
* [http://library.gnome.org/devel/hig-book/stable/principles-forgiveness.html.en Forgive the User]
* [http://library.gnome.org/devel/hig-book/stable/principles-direct-manipulation.html.en Provide Direct Manipulation]
== Missing guidelines ==


=== Still missing guidelines ===
=== Unwritten guidelines ===
* Building blocks
* Building blocks
** [[Development:Course Format|Course Format]]
** [[Development:Course Format|Course Format]]
Line 38: Line 56:
* Popup Window
* Popup Window


=== Guidelines that may one day be ===
=== Guidelines that require further research/discussion ===
These are plans to create new interaction styles, switch existing conventions for more usable ones, or issues that are still unclear and need to be further discussed to become actual guidelines.
These are plans to create new interaction styles, switch existing conventions for more usable ones, or issues that are still unclear and need to be further discussed to become actual guidelines.


Line 53: Line 71:
* Waiting for developments of Navigation 2.0: Tabs
* Waiting for developments of Navigation 2.0: Tabs
* Command Popup Menu
* Command Popup Menu
== General design guidelines ==
* [[Development:Progressive Disclosure|Progressive Disclosure]]
* [[Development:User Data Always Safe|User Data Always (Always) Safe]]
* Feedback
** See [http://mahara.org/view/view.php?id=3482 presentation] ([http://mahara.org/artefact/file/download.php?file=14278&view=3482 alternate link]) of workshop by David Mudrak for the future direction of feedback
** GNOME: [http://library.gnome.org/devel/hig-book/stable/feedback.html.en Feedback]
*** (for Desktop but still a great guide and mostly applicable to Moodle)
=== Relevant guidelines from other sites ===
* [http://library.gnome.org/devel/hig-book/stable/principles-people.html.en Design for People]
* [http://library.gnome.org/devel/hig-book/stable/principles-broad-userbase.html.en Don't Limit Your User Base]
* [http://library.gnome.org/devel/hig-book/stable/principles-match.html.en Create a Match Between Your Application and the Real World]
* [http://library.gnome.org/devel/hig-book/stable/principles-consistency.html.en Make Your Application Consistent]
* [http://library.gnome.org/devel/hig-book/stable/principles-feedback.html.en Keep the User Informed]
* [http://library.gnome.org/devel/hig-book/stable/principles-simplicity.html.en Keep It Simple and Pretty]
* [http://library.gnome.org/devel/hig-book/stable/principles-user-control.html.en Put the User in Control]
* [http://library.gnome.org/devel/hig-book/stable/principles-forgiveness.html.en Forgive the User]
* [http://library.gnome.org/devel/hig-book/stable/principles-direct-manipulation.html.en Provide Direct Manipulation]


== See also ==
== See also ==

Revision as of 18:58, 8 August 2009

Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.

The greatest risk of this effort is that developers may not find it when they need it, while designing parts of Moodle. Please help: look at what is here already now, and comment: How could it serve your development work better? What aspects of user interface design would you need clear guidelines on? If there is any reason you feel you can not benefit from the guidelines, please tell me about it in the developer forum thread. See also: Introduction



Moodle basics

Moodle UI library

UIs are built of Elements and Interaction Styles (bigger wholes, which are built of Elements).

Elements

Interaction Styles

General design guidelines

Relevant guidelines from other sites

Missing guidelines

Unwritten guidelines

  • Building blocks
    • Course Format
    • Block (not a technical guide but a guideline how what to take into account when using a block as a part of a design)
    • Filter
    • Module (not a technical guide but a guideline how what to take into account when using a module as a part of a design)
  • Dialog
  • Popup Window

Guidelines that require further research/discussion

These are plans to create new interaction styles, switch existing conventions for more usable ones, or issues that are still unclear and need to be further discussed to become actual guidelines.

Development:Major usability issues in Moodle (separate design projects)

  • Switch Button
  • Add element
  • Jump Navigation
  • Move Element (Course front page model vs. quiz)
  • Quick Inline Help ([1] for now)
  • Further research required: Search
  • Further research required: Editing modes
  • Further research required: Data Listing
  • Waiting for developments of Navigation 2.0: Tabs
  • Command Popup Menu

See also

Using Moodle book

About writing these guidelines

Usability in Moodle

Implementation advice

Todo