Difference between revisions of "Wiki Template for new project"
Jump to navigation
Jump to search
m |
|||
| Line 2: | Line 2: | ||
This is a template which you can use to help get you started on a Wiki for a new visualisation project - it serves as a dynamic 'ReadMe' file of your project. The template is just intended as a guide and you may modify the structure to suit your project. | This is a template which you can use to help get you started on a Wiki for a new visualisation project - it serves as a dynamic 'ReadMe' file of your project. The template is just intended as a guide and you may modify the structure to suit your project. | ||
When a new project is started, the 'Contributors' and 'Aims & | When a new project is started, the 'Contributors' and 'Aims & Learning Outcomes' sections need to be filled out. Aim to include the rest of the information by the time the design is finalised. The page can be updated whenever the visualisation is updated - ensure to credit all contributors! | ||
== Contributors == | == Contributors == | ||
| Line 11: | Line 11: | ||
* What rough dates did they contribute? | * What rough dates did they contribute? | ||
== Aims & | == Aims & Learning Outcomes == | ||
* Explain the motivation for your visualisation. | * Explain the motivation for your visualisation. | ||
Revision as of 08:31, 23 September 2021
This is a template which you can use to help get you started on a Wiki for a new visualisation project - it serves as a dynamic 'ReadMe' file of your project. The template is just intended as a guide and you may modify the structure to suit your project.
When a new project is started, the 'Contributors' and 'Aims & Learning Outcomes' sections need to be filled out. Aim to include the rest of the information by the time the design is finalised. The page can be updated whenever the visualisation is updated - ensure to credit all contributors!
Contributors
- Name and department of each person.
- Student or staff partner?
- How is/was each person involved?
- What rough dates did they contribute?
Aims & Learning Outcomes
- Explain the motivation for your visualisation.
- Introduce the subject of your visualisation.
- Which module and year is it intended for and which setting (lecture or self study)?
- List learning outcomes. E.g.: "After using this visualisation, students should be able to explain that..."
Design Overview
- Once the design is agreed, describe the final outcome, how it looks, how it functions etc.
- Include graphics.
Design Justification
Optionally describe any notable decisions made for the design, e.g.
- Educational design: breaking down of concepts (scaffolding)
- How were accessibility issues considered?
- How was space used effectively?
- How is the design intuitive?
- Choice of interactive element(s) that fit in organically with the visualisation [inspiration of choice might be from lecture/in-class activity or other sources] - Sliders/Buttons/Cursor (hover/click).
Progress and Future Work
- Is the design finalised (i.e. agreed by all partners)?
- If applicable, which pages have been uploaded to website?
- Any ideas for future improvements.
Resources
- Links to code or notes used.