Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaoranzhou authored Sep 17, 2024
1 parent d14081a commit 793a81c
Showing 1 changed file with 28 additions and 5 deletions.
33 changes: 28 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,31 @@
# Prototype for metadata recommendation tools
# Metadata Quiz Tool

## Motivation
To make metadata annotation more approachable.
To support researchers with metadata annotation over the entire investigation lifecycle
The **Metadata Quiz Tool** provides a user-friendly interface to help researchers identify and recommend relevant metadata standards, SWATE templates, and publication archives. The tool is designed to simplify the often complex task of metadata annotation, offering personalized suggestions through a guided quiz.

## Purpose

![image](https://github.com/xiaoranzhou/metadata/assets/29843510/15429964-e07f-4f88-83d4-6d651bf04485)
The goal of the Metadata Quiz Tool is to streamline the metadata annotation process throughout the research lifecycle. By answering a few simple questions, researchers can access curated lists of repositories and standards tailored to their specific research needs, ensuring that data is well-documented and meets community standards.

## How It Works

By answering just **three questions** (as shown in the screenshot below), the tool provides suggestions on:
- Metadata standards
- Minimum Information (MI) standards
- SWATE () templates
- Relevant publication repositories

![image](https://github.com/user-attachments/assets/98fcdc2b-4e44-4521-adf7-8b6d3ab2ab0d)

Once the quiz is completed, the tool compiles and displays a list with direct links to recommended resources. Users can navigate through this list, finding both direct links to resources and additional information to guide them in metadata selection.

![image](https://github.com/user-attachments/assets/1518bf3d-a6e1-4d5c-badd-c7db2a04301d)

## Key Features

- **Three-question quiz**: Quick and easy-to-use interface to help researchers define their metadata requirements.
- **Metadata Recommendations**: Suggestions for appropriate metadata standards, templates, and publication repositories.
- **Resource Links**: Direct navigation to metadata resources and additional guidance.

## Usage

[Access it by a single click](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/implementation/MetadataQuiz.html)

0 comments on commit 793a81c

Please sign in to comment.