Our design and development process - Revision history

Cclewley: /* Connecting with our community */

2021-10-04T20:34:58Z

Connecting with our community

← Older revision		Revision as of 20:34, 4 October 2021
Line 4:		Line 4:
	ImpVis has three platforms of communication for separate purposes:		ImpVis has three platforms of communication for separate purposes:

	* The [https://impvis.co.uk website], which is public-facing and displays all our finalised visualisations plus current projects. If you wish to become an ImpVis member, '''you need to [https://impvis.co.uk/register register] s'''o the site's full functionality is available to you.		* The [https://impvis.co.uk website], which is public-facing and displays all our finalised visualisations plus current projects. If you wish to become an ImpVis member, '''''you need to [https://impvis.co.uk/register register]''''' so the site's full functionality is available to you.
	* This [[Main Page\|Wiki]], which is our 'dynamic knowledgebase'. Here you can find out everything about how we work together, as well as guidance to help you design and code up your visualisation. Projects have their own associated Wiki pages which serve as 'ReadMe' files to document their aim, learning outcomes, and development. Most of the Wiki is only visible to ImpVis members. If you are signed up to the ImpVis website, '''you will automatically have an associated Wiki account with the ~~same login details~~'''. Alternatively you can create a Wiki account by clicking the 'Create Account' link at the top right of the Wiki page.		* This [[Main Page\|Wiki]], which is our 'dynamic knowledgebase'. Here you can find out everything about how we work together, as well as guidance to help you design and code up your visualisation. Projects have their own associated Wiki pages which serve as 'ReadMe' files to document their aim, learning outcomes, and development. Most of the Wiki is only visible to ImpVis members. If you are signed up to the ImpVis website, '''''you will automatically have an associated Wiki account''''' with username of the format ''FirstnameLastname'' as entered during your ImpVis registration, with the same password as for the ImpVis website. Alternatively you can create a Wiki account by clicking the 'Create Account' link at the top right of the Wiki page.
	* Our Teams space, which is the main communication platform for our team. This is where we set up meetings and discuss projects in dedicated channels. ~~'''~~Request access to our Teams space [https://impvis.co.uk/join here]~~'''~~.		* Our Teams space, which is the main communication platform for our team. This is where we set up meetings and discuss projects in dedicated channels. Request access to our Teams space [https://impvis.co.uk/join here].

	== Getting involved on a visualisation project ==		== Getting involved on a visualisation project ==

Cclewley: /* Visualisation design based on aims and learning outcomes */

2021-09-30T18:11:00Z

Visualisation design based on aims and learning outcomes

← Older revision		Revision as of 18:11, 30 September 2021
Line 18:		Line 18:
	* What will the visualisation look like and how will it work? You will need to create a design sketch, including the visual and interactive elements of the visualisation.		* What will the visualisation look like and how will it work? You will need to create a design sketch, including the visual and interactive elements of the visualisation.

	All of the above will need to be documented on the visualisation's dedicated Wiki project page~~. Before you start, have a look at the following resources:~~		All of the above will need to be documented on the visualisation's dedicated Wiki project page. Find guidance on design decisions in our [[Knowledgebase#Visualisation design guidance\|knowledgebase]].

	* [[Solid Angles Design\|Example]] of a finalised design.
	* [[Wiki Template for new project\|Template]] Wiki page for a new project.
	~~Start by creating your own Wiki page by copying the template Wiki above and filling in the sections~~. Find guidance on design decisions in our [[Knowledgebase#Visualisation design guidance\|knowledgebase]].

	Once all staff partners are happy with the design, they formally confirm their agreement on the website to move their project to the development stage (read [[Managing your project on the ImpVis website\|here]] about how to do this).		Once all staff partners are happy with the design, they formally confirm their agreement on the website to move their project to the development stage (read [[Managing your project on the ImpVis website\|here]] about how to do this).
Line 34:		Line 30:

	== Review process by peers and staff partner(s) ==		== Review process by peers and staff partner(s) ==
	Once all the functionality in the initial design has been coded up, the visualisation will be reviewed by peers and the staff partner. This process is done via the ImpVis website. ~~Read all about it in the following pages:~~		Once all the functionality in the initial design has been coded up, the visualisation will be reviewed by peers and the staff partner. This process is done via the ImpVis website.

	~~# [[Uploading a new visualisation\|Uploading a visualisation]]~~
	~~# [[Review\|Reviewing a visualisation]]~~

	Reviewers can raise any issues they find via the website and indicate their priority. Developers will be notified of any issues raised - they can then implement these and upload a new version of the visualisation.		Reviewers can raise any issues they find via the website and indicate their priority. Developers will be notified of any issues raised - they can then implement these and upload a new version of the visualisation.
Line 44:		Line 37:

	== Publication on the website ==		== Publication on the website ==
	Once all reviewers have finished their review and there are no outstanding critical issues, the visualisation will automatically be approved and published on the '[https://impvis.co.uk/teach Teach]' environment of the website. The only remaining action is to link the visualisation to the module for which it was intended, by creating a Collection for publication on the 'Learn' environment of the website. This will ensure students can find relevant visualisations easily~~. [[Creating a Collection\|This page]] contains full guidance on creating a Collection~~. As always, find full guidance in our [[knowledgebase]].		Once all reviewers have finished their review and there are no outstanding critical issues, the visualisation will automatically be approved and published on the '[https://impvis.co.uk/teach Teach]' environment of the website. The only remaining action is to link the visualisation to the module for which it was intended, by creating a Collection for publication on the 'Learn' environment of the website. This will ensure students can find relevant visualisations easily. As always, find full guidance in our [[Index.php?title=Knowledgebase#Review and publication of your visualisation\|knowledgebase]].

	== Further updates to the visualisation ==		== Further updates to the visualisation ==

Cclewley: /* Review process by peers and staff partner(s) */

2021-09-30T17:52:22Z

Review process by peers and staff partner(s)

← Older revision		Revision as of 17:52, 30 September 2021
Line 39:		Line 39:
	# [[Review\|Reviewing a visualisation]]		# [[Review\|Reviewing a visualisation]]

	Reviewers can raise any issues they find via the website and indicate their priority. Developers will be notified of any issues raised - they can then implement these and upload a new version of the visualisation.		Reviewers can raise any issues they find via the website and indicate their priority. Developers will be notified of any issues raised - they can then implement these and upload a new version of the visualisation.

			Find full guidance on everything to do with uploading and reviewing in our [[Knowledgebase#Review and publication of your visualisation\|knowledgebase]].

	== Publication on the website ==		== Publication on the website ==
	Once all reviewers have finished their review and there are no outstanding critical issues, the visualisation will automatically be approved and published on the '[https://impvis.co.uk/teach Teach]' environment of the website. The only remaining action is to link the visualisation to the module for which it was intended, by creating a Collection for publication on the 'Learn' environment of the website. This will ensure students can find relevant visualisations easily. ~~<u>~~This page contains full guidance on creating a Collection~~</u>~~.		Once all reviewers have finished their review and there are no outstanding critical issues, the visualisation will automatically be approved and published on the '[https://impvis.co.uk/teach Teach]' environment of the website. The only remaining action is to link the visualisation to the module for which it was intended, by creating a Collection for publication on the 'Learn' environment of the website. This will ensure students can find relevant visualisations easily. [[Creating a Collection\|This page]] contains full guidance on creating a Collection. As always, find full guidance in our [[knowledgebase]].

	== Further updates to the visualisation ==		== Further updates to the visualisation ==
	Finally, once all the steps above have been taken for 'version 1.0' of the visualisation, any future work ideas may initiate a new project or a new design phase for a more advanced version of the visualisation. Ensure that any updates to the visualisation design are documented in the visualisation's Wiki page and contributors duly credited.		Finally, once all the steps above have been taken for 'version 1.0' of the visualisation, any future work ideas may initiate a new project or a new design phase for a more advanced version of the visualisation. Ensure that any updates to the visualisation design are documented in the visualisation's Wiki page and contributors duly credited. New versions can be [[Uploading a new version of your visualisation\|uploaded]] to supersede all visualisation versions.

	__FORCETOC__		__FORCETOC__
	[[Category:Getting Started]]		[[Category:Getting Started]]

Cclewley: /* Visualisation design based on aims and learning outcomes */

2021-09-30T17:49:06Z

Visualisation design based on aims and learning outcomes

← Older revision		Revision as of 17:49, 30 September 2021
Line 22:		Line 22:
	* [[Solid Angles Design\|Example]] of a finalised design.		* [[Solid Angles Design\|Example]] of a finalised design.
	* [[Wiki Template for new project\|Template]] Wiki page for a new project.		* [[Wiki Template for new project\|Template]] Wiki page for a new project.
	Start by creating your own Wiki page by copying the template Wiki above and filling in the sections. Find guidance on design ~~decision~~ in our [[Knowledgebase#Visualisation design guidance\|knowledgebase]].		Start by creating your own Wiki page by copying the template Wiki above and filling in the sections. Find guidance on design decisions in our [[Knowledgebase#Visualisation design guidance\|knowledgebase]].

	Once all staff partners are happy with the design, they formally confirm their agreement on the website to move their project to the development stage (read [[Managing your project on the ImpVis website\|here]] about how to do this).		Once all staff partners are happy with the design, they formally confirm their agreement on the website to move their project to the development stage (read [[Managing your project on the ImpVis website\|here]] about how to do this).

Cclewley: /* Review process by peers and staff partner(s) */

2021-09-29T16:58:18Z

Review process by peers and staff partner(s)

← Older revision		Revision as of 16:58, 29 September 2021
Line 36:		Line 36:
	Once all the functionality in the initial design has been coded up, the visualisation will be reviewed by peers and the staff partner. This process is done via the ImpVis website. Read all about it in the following pages:		Once all the functionality in the initial design has been coded up, the visualisation will be reviewed by peers and the staff partner. This process is done via the ImpVis website. Read all about it in the following pages:

	# ~~<u>~~Uploading a visualisation~~</u>~~		# [[Uploading a new visualisation\|Uploading a visualisation]]
	# ~~<u>~~Reviewing a visualisation~~</u>~~		# [[Review\|Reviewing a visualisation]]

	Reviewers can raise any issues they find via the website and indicate their priority. Developers will be notified of any issues raised - they can then implement these and upload a new version of the visualisation.		Reviewers can raise any issues they find via the website and indicate their priority. Developers will be notified of any issues raised - they can then implement these and upload a new version of the visualisation.

Cclewley: /* Review process by peers and staff partner(s) */

2021-09-28T12:10:10Z

Review process by peers and staff partner(s)

← Older revision		Revision as of 12:10, 28 September 2021
Line 36:		Line 36:
	Once all the functionality in the initial design has been coded up, the visualisation will be reviewed by peers and the staff partner. This process is done via the ImpVis website. Read all about it in the following pages:		Once all the functionality in the initial design has been coded up, the visualisation will be reviewed by peers and the staff partner. This process is done via the ImpVis website. Read all about it in the following pages:

	# Uploading a visualisation		# <u>Uploading a visualisation</u>
	# Reviewing a visualisation		# <u>Reviewing a visualisation</u>

	Reviewers can raise any issues they find via the website and indicate their priority. Developers will be notified of any issues raised - they can then implement these and upload a new version of the visualisation.		Reviewers can raise any issues they find via the website and indicate their priority. Developers will be notified of any issues raised - they can then implement these and upload a new version of the visualisation.

	== Publication on the website ==		== Publication on the website ==
	Once all reviewers have finished their review and there are no outstanding critical issues, the visualisation will automatically be approved and published on the '[https://impvis.co.uk/teach Teach]' environment of the website. The only remaining action is to link the visualisation to the module for which it was intended, by creating a Collection for publication on the 'Learn' environment of the website. This will ensure students can find relevant visualisations easily. This page contains full guidance on creating a Collection.		Once all reviewers have finished their review and there are no outstanding critical issues, the visualisation will automatically be approved and published on the '[https://impvis.co.uk/teach Teach]' environment of the website. The only remaining action is to link the visualisation to the module for which it was intended, by creating a Collection for publication on the 'Learn' environment of the website. This will ensure students can find relevant visualisations easily. <u>This page contains full guidance on creating a Collection</u>.

	== Further updates to the visualisation ==		== Further updates to the visualisation ==

Cclewley: /* Visualisation design based on aims and learning outcomes */

2021-09-24T18:45:46Z

Visualisation design based on aims and learning outcomes

← Older revision		Revision as of 18:45, 24 September 2021
Line 22:		Line 22:
	* [[Solid Angles Design\|Example]] of a finalised design.		* [[Solid Angles Design\|Example]] of a finalised design.
	* [[Wiki Template for new project\|Template]] Wiki page for a new project.		* [[Wiki Template for new project\|Template]] Wiki page for a new project.
	Start by creating your own Wiki page by copying the template Wiki above and filling in the sections.		Start by creating your own Wiki page by copying the template Wiki above and filling in the sections. Find guidance on design decision in our [[Knowledgebase#Visualisation design guidance\|knowledgebase]].

	Once all staff partners are happy with the design, they formally confirm their agreement on the website to move their project to the development stage (read [[Managing your project on the ImpVis website\|here]] about how to do this).		Once all staff partners are happy with the design, they formally confirm their agreement on the website to move their project to the development stage (read [[Managing your project on the ImpVis website\|here]] about how to do this).

Cclewley: /* Visualisation design based on aims and learning outcomes. */

2021-09-24T18:44:32Z

Visualisation design based on aims and learning outcomes.

← Older revision		Revision as of 18:44, 24 September 2021
Line 11:		Line 11:
	Once you have connected with our community, you can get started on a project. You can choose to propose your own project, or sign up to an advertised project. Read all about how to do this [[Getting involved\|here]].		Once you have connected with our community, you can get started on a project. You can choose to propose your own project, or sign up to an advertised project. Read all about how to do this [[Getting involved\|here]].

	== Visualisation design based on aims and learning outcomes. ==		== Visualisation design based on aims and learning outcomes ==
	A good design process is fundamental to creating an effective interactive visualisation for education. Before any coding starts, there needs to be a clear plan for ‘version 1.0’ of the visualisation. This requires clearly defining the following:		A good design process is fundamental to creating an effective interactive visualisation for education. Before any coding starts, there needs to be a clear plan for ‘version 1.0’ of the visualisation. This requires clearly defining the following:

Cclewley: /* Visualisation design based on aims and learning outcomes. */

2021-09-24T18:41:34Z

Visualisation design based on aims and learning outcomes.

← Older revision		Revision as of 18:41, 24 September 2021
Line 12:		Line 12:

	== Visualisation design based on aims and learning outcomes. ==		== Visualisation design based on aims and learning outcomes. ==
	A good design process is fundamental to creating an effective interactive visualisation for education. Before any coding starts, there needs to be a clear plan for ‘version 1.0’ of the visualisation. This requires defining learning outcomes and ~~creating~~ a design sketch, including the visual and interactive elements of the visualisation. ~~The design~~ will need to be documented on the visualisation's dedicated Wiki page. Before you start, have a look at the following resources:		A good design process is fundamental to creating an effective interactive visualisation for education. Before any coding starts, there needs to be a clear plan for ‘version 1.0’ of the visualisation. This requires clearly defining the following:

			* How will the visualisation fit into the module for which it is intended (its implementation)?
			* What are the most important points that users of the visualisation need to take away from it (the intended learning outcomes)?
			* What will the visualisation look like and how will it work? You will need to create a design sketch, including the visual and interactive elements of the visualisation.

			All of the above will need to be documented on the visualisation's dedicated Wiki project page. Before you start, have a look at the following resources:

	* [[Solid Angles Design\|Example]] of a finalised design.		* [[Solid Angles Design\|Example]] of a finalised design.
	* [[Wiki Template for new project\|Template]] Wiki page for a new project.		* [[Wiki Template for new project\|Template]] Wiki page for a new project.
			Start by creating your own Wiki page by copying the template Wiki above and filling in the sections.

	~~It is vital during~~ the design ~~phase~~ to ~~remain focussed~~ on the ~~main learning objectives~~.		Once all staff partners are happy with the design, they formally confirm their agreement on the website to move their project to the development stage (read [[Managing your project on the ImpVis website\|here]] about how to do this).

	~~Once started on a visualisation, it~~ is ~~common to have many new ideas for improvement~~. ~~However, this can lead to~~ a visualisation ~~never being finished to a sufficient standard to be used by learners. We therefore follow an agile development process: ensuring that~~ ‘version 1.0’ of ~~each~~ visualisation ~~is uploaded~~ for ~~review~~ as ~~soon~~ as the ~~initial design has been realised, before implementing further extensions~~.		== Visualisation development in Javascript and HTML ==
			This is the programming phase. With the aid of a visualisation template the ‘version 1.0’ functionality of the visualisation will be coded up in Javascript / HTML / CSS. In our [[Knowledgebase#Guidance for coding up visualisations\|knowledgebase]] you can find extensive guidance on the coding process as well as tips on how to get started learning the relevant programming languages and packages.

	~~Note down any extension ideas in~~ the ~~'Future Work' section of your Wiki page. You can~~ design and ~~develop these at a later phase, when your original ideas have been fully developed and uploaded~~. ~~Once started on a visualisation~~, it is common to have many new ideas for improvement. However, this can lead to a visualisation never being finished to a sufficient standard to be used by learners. We therefore follow an agile development process: ensuring that ‘version 1.0’ of each visualisation is uploaded for review as soon as the initial design has been realised, before implementing further extensions. This means you are more likely to achieve the satisfaction of seeing your visualisation put to good use by learners!		At this stage, it is vital to remain focussed on the original design and intended learning outcomes. During the coding process, it is common to have many new ideas for improvement. However, this can lead to a visualisation never being finished to a sufficient standard to be used by learners. We therefore follow an agile development process: ensuring that ‘version 1.0’ of each visualisation is uploaded for review as soon as the initial design has been realised, before implementing further extensions. This means you are more likely to achieve the satisfaction of seeing your visualisation put to good use by learners!

	~~Once all staff partners are happy with the design, they formally confirm their agreement on the website~~ to ~~move their project to the development stage (read [[Managing your project on the ImpVis website\|here]] about how to do this).~~		Ensure to note down any extension ideas in the 'Future Work' section of your Wiki page. You can design and develop these at a later phase, when your original ideas have been fully developed and uploaded.

	~~== Visualisation development in Javascript and HTML ==~~
	This is the programming phase. With the aid of a visualisation template the ‘version 1.0’ functionality of the visualisation will be coded up in Javascript / HTML / CSS. There is extensive guidance to be found on our Wiki on the coding process as well as tips on how to get started learning the relevant programming languages and packages. Again, the focus should be on implementing the 'version 1.0' design: any ~~new~~ ideas ~~should be noted down~~ in the 'Future Work' section of ~~the visualisation's~~ Wiki page.

	== Review process by peers and staff partner(s) ==		== Review process by peers and staff partner(s) ==

Cclewley at 16:14, 24 September 2021

2021-09-24T16:14:51Z

← Older revision		Revision as of 16:14, 24 September 2021
Line 43:		Line 43:

	__FORCETOC__		__FORCETOC__
			[[Category:Getting Started]]

← Older revision		Revision as of 17:49, 30 September 2021
Line 22:		Line 22:
	* [[Solid Angles Design\|Example]] of a finalised design.		* [[Solid Angles Design\|Example]] of a finalised design.
	* [[Wiki Template for new project\|Template]] Wiki page for a new project.		* [[Wiki Template for new project\|Template]] Wiki page for a new project.
	Start by creating your own Wiki page by copying the template Wiki above and filling in the sections. Find guidance on design ~~decision~~ in our [[Knowledgebase#Visualisation design guidance\|knowledgebase]].		Start by creating your own Wiki page by copying the template Wiki above and filling in the sections. Find guidance on design decisions in our [[Knowledgebase#Visualisation design guidance\|knowledgebase]].

	Once all staff partners are happy with the design, they formally confirm their agreement on the website to move their project to the development stage (read [[Managing your project on the ImpVis website\|here]] about how to do this).		Once all staff partners are happy with the design, they formally confirm their agreement on the website to move their project to the development stage (read [[Managing your project on the ImpVis website\|here]] about how to do this).

← Older revision		Revision as of 18:45, 24 September 2021
Line 22:		Line 22:
	* [[Solid Angles Design\|Example]] of a finalised design.		* [[Solid Angles Design\|Example]] of a finalised design.
	* [[Wiki Template for new project\|Template]] Wiki page for a new project.		* [[Wiki Template for new project\|Template]] Wiki page for a new project.
	Start by creating your own Wiki page by copying the template Wiki above and filling in the sections.		Start by creating your own Wiki page by copying the template Wiki above and filling in the sections. Find guidance on design decision in our [[Knowledgebase#Visualisation design guidance\|knowledgebase]].

	Once all staff partners are happy with the design, they formally confirm their agreement on the website to move their project to the development stage (read [[Managing your project on the ImpVis website\|here]] about how to do this).		Once all staff partners are happy with the design, they formally confirm their agreement on the website to move their project to the development stage (read [[Managing your project on the ImpVis website\|here]] about how to do this).