Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Moodle User Interface Guidelines:Introduction: Difference between revisions

From MoodleDocs
mNo edit summary
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[ Moodle User Interface Guidelines|Moodle User Interface Guidelines]] > '''Introduction'''
[[ Moodle User Interface Guidelines|Moodle User Interface Guidelines]] > '''Introduction'''


== Introduction ==
'''These guidelines are to be used as a '''UI reference library''' by Moodle developers when creating user interfaces. '''
These guidelines are a reference for Moodle developers.  


'''The primary purpose''' is to document what is already there. While I was developing [[Quiz UI redesign|a UI]] for the Quiz module, it often seemed that it was rather difficult to know how exactly to make an UI coherent with the Moodle style. I have started to find out, and I intend to document it, so that Moodle can give a more consistent user experience in the future, by helping developers quickly find what there already is. The guidelines under the heading '''Moodle UI style''' aim for this purpose.
'''It does not catalogue all the elements in use in Moodle, but is intended a reference of reusable elements sharing that common Moodle style. We aim to update this reference as new common practices appear.'''


'''The other, and perhaps a longer-term purpose''' is to have a bit of a reference and a foundation to invoke discussion about usability issues. They are guidelines that often apply not only to Moodle but also to other web applications. They also aim to make Moodle more welcoming to people coming from elsewhere on the web, to whom Moodle UI might at first seem strange. These guidelines are under the heading '''User Interface Design Guidelines'''.
''The primary purpose'' is to document what is already there, the parts of Moodle that are proven by practice to work. What is the Moodle style - what is specific about the Moodle UI that makes it Moodlish and is better than any other UI for the purpose it serves? It often seems it is difficult to know how to make an UI coherent with the Moodle style. I have started to find out, and I intend to document it. This way, Moodle can give a more consistent user experience in the future, by helping developers quickly find what there already is. The guidelines under the heading '''Moodle UI library''' are meant for this.


This is not a usability project that would address all of Moodle, and no user research is involved at this time, though I will usability test some of the guidelines. Having some level of consistency is just a starting point for actual usability work.
All of the guidelines are to have a link to a document called "Examples and Code Samples: [Guideline Name] ", where it is documented where to look for examples on how to implement a given guideline in practice.


== Status in June 2009 ==
''The other, and perhaps a longer-term purpose'' is to have a bit of a reference and a foundation to invoke discussion about usability issues. There are many guidelines that often apply not only to Moodle but also to other web applications. Getting them right also helps to make Moodle more welcoming to people coming from elsewhere on the web, and use Moodle only occasionally. These guidelines are under the heading '''General design guidelines'''.
 
Reaching for both of these goals, I invite you to join me. I am currently funded for the duration of the summer of 2009, which can get us started together. I want to find out how this should look like to serve the community best.
 
You can help by '''commenting on [[Guideline_template]] and on [[Progressive_Disclosure]]'''. The former describes how the latter is written, so it might be a good idea to read and compare these side-by-side. If you wish, you can even add new guidelines yourself - don't worry about if they look right yet - and I can take a look at them too. During July 2009, the number of guidelines will increase - if not by you, then by me. '''I will hope to have a lot of eyes on them to make sure they are easy to understand and use'''.
 
I am still trying to find a balance between the using a lot of time to use in writing and iterating a guideline page to be readable and getting a reasonable number of guidelines written.
 
The point is to have something everybody will use in development. I want you to reject this, but do it now, please, not later :). Tell me what you think might be better. Let us build this together.
 
Thanks!
--[[User:Olli Savolainen|Olli Savolainen]] 13:53, 26 June 2009 (UTC)
 
P.S. You are also welcome to take a look at the [[Usability/Improve_Moodle_User_Experience_Consistency|project page]], but I am warning you, there's a lot to digest there.
 
 
===Notes===
 
* TODO 2009-06-26: refer to the index also, add work in progress template to big select list
* TODO: look at the introduction writings of well-known HIGs

Latest revision as of 14:08, 22 August 2011

Moodle User Interface Guidelines > Introduction

These guidelines are to be used as a UI reference library by Moodle developers when creating user interfaces.

It does not catalogue all the elements in use in Moodle, but is intended a reference of reusable elements sharing that common Moodle style. We aim to update this reference as new common practices appear.

The primary purpose is to document what is already there, the parts of Moodle that are proven by practice to work. What is the Moodle style - what is specific about the Moodle UI that makes it Moodlish and is better than any other UI for the purpose it serves? It often seems it is difficult to know how to make an UI coherent with the Moodle style. I have started to find out, and I intend to document it. This way, Moodle can give a more consistent user experience in the future, by helping developers quickly find what there already is. The guidelines under the heading Moodle UI library are meant for this.

All of the guidelines are to have a link to a document called "Examples and Code Samples: [Guideline Name] ", where it is documented where to look for examples on how to implement a given guideline in practice.

The other, and perhaps a longer-term purpose is to have a bit of a reference and a foundation to invoke discussion about usability issues. There are many guidelines that often apply not only to Moodle but also to other web applications. Getting them right also helps to make Moodle more welcoming to people coming from elsewhere on the web, and use Moodle only occasionally. These guidelines are under the heading General design guidelines.

Retrieved from "https://docs.moodle.org/dev/index.php?title=Moodle_User_Interface_Guidelines:Introduction&oldid=29248"
Powered by MediaWiki