Skip to content

Commit

Permalink
updated templates and readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
pouliens committed Jul 22, 2024
1 parent c5be3b6 commit 111df0f
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 17 deletions.
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,28 @@ We encourage community contributions! You can share your own resources, case stu

> Case studies showcase real-world examples of how UX (User Experience) methods have been successfully applied to address **environmental data** challenges. Your contributions should include a brief overview of the project, the specific UX methods used (e.g., design sprints, user research, prototyping), the outcomes achieved, and any key takeaways for others working on similar projects. Your case studies will inspire and guide others in the field, demonstrating the power of user-centered design.
1. Create a new markdown file in the [co-creation-toolkit/src/content/case-studies/](https://github.com/pautva/co-creation-toolkit/tree/main/src/content/case-studies) folder following the template structure.
2. Specify the [category](https://pautva.github.io/co-creation-toolkit/toolkit/) under which the method/tool should be shown in the markdown file:
* **User Research**
* **Design and Prototyping**
* **Evaluation**
* **Collaboration**
3. Add images and other assets to the Case Studies Assets folder (https://github.com/pautva/co-creation-toolkit/tree/main/static/assets/case-studies)
4. Create a pull request into the main branch
1. Create a new markdown file in the [co-creation-toolkit/src/content/case-studies/](https://github.com/pautva/co-creation-toolkit/tree/main/src/content/case-studies) folder following [this template](https://github.com/pautva/co-creation-toolkit/blob/main/src/content/templates/case-study.md).
2. Update the case study description at the top of the page
3. Add content below the '---' line
4. Add images and other assets to the Case Studies Assets folder (https://github.com/pautva/co-creation-toolkit/tree/main/static/assets/case-studies)
5. Create a pull request into the main branch
6. Once the updated files are merged into the `main` branch, the website will be updated

## Add new tools to the UX Toolkit

> Toolkit includes templates, guides, and documents that can help others implement effective UX practices in their **environmental data** projects. Think of things like persona templates, interview guides, product requirement documents, usability testing scripts, and any other tools you've found valuable. Your contributions will empower others to gather user insights, design user-friendly solutions, and create impactful environmental data products and services.
1. Create a new markdown file in the [co-creation-toolkit/src/content/toolkit/](https://github.com/pautva/co-creation-toolkit/tree/main/src/content/toolkit) folder following the template structure.
2. Add images and other assets to the Toolkit Assets folder (https://github.com/pautva/co-creation-toolkit/tree/main/static/assets/toolkit)
3. Create a pull request into the main branch
1. Create a new markdown file in the [co-creation-toolkit/src/content/toolkit/](https://github.com/pautva/co-creation-toolkit/tree/main/src/content/toolkit) folder following this [template](https://github.com/pautva/co-creation-toolkit/blob/main/src/content/templates/toolkit-method.md).
2. Update the toolkit description at the top of the page
3. Specify the [category](https://pautva.github.io/co-creation-toolkit/toolkit/) under which the method/tool should be shown in the markdown file:
* **User Research**
* **Design and Prototyping**
* **Evaluation**
* **Collaboration**
4. Add content below the '---' line
5. Add images and other assets to the Toolkit Assets folder (https://github.com/pautva/co-creation-toolkit/tree/main/static/assets/toolkit)
6. Create a pull request into the main branch
7. Once the updated files are merged into the `main` branch, the website will be updated

## Markdown Cheat Sheet

Expand Down
34 changes: 34 additions & 0 deletions src/content/templates/case-study.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Title
publishDate: 2024-07-08 00:00:00
img: /co-creation-toolkit/assets/case-studies/covers/cs-cover-01.png
img_alt: Cover description
description: Case study description
tags:
- Tag 1
- Tag 2
- Tag 3
organisation: BGS
featured: false
---

## Overview

> Intro sentence
![Image](/co-creation-toolkit/assets/case-studies/case-study-name/iamge-name.png)
*Image description*

### heading 1

Lore ipsum

### Heading 2

1. Lore ipsum
2. Lore ipsum
3. Lore ipsum

## Links

* [Link title](#)
8 changes: 2 additions & 6 deletions src/content/templates/toolkit-method.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Title
publishDate: 2024-07-08 00:00:00
# img: /co-creation-toolkit/assets/illustrations/nldp-farmer.svg
img: /co-creation-toolkit/assets/toolkit/covers/toolkit-cover-15.svg
img_alt: Cover description
description: Tool description
Expand All @@ -17,16 +16,13 @@ featured: false

> Intro sentence
![Image](/co-creation-toolkit/assets/case-studies/dsts/dsts-mockup.png)
*Wirefreame for common layouts of decision support tools*
![Image](/co-creation-toolkit/assets/case-studies/case-study-name/iamge-name.png)
*Image description*

### heading 1

Lore ipsum

![Image](/co-creation-toolkit/assets/case-studies/dsts/do-you-need-dsts.png)
*Screenshot from the brochure created for this best practice documentation*

### Heading 2

1. Lore ipsum
Expand Down

0 comments on commit 111df0f

Please sign in to comment.