From 793a81cbeb14abf96f888cd3cbc60a6dfa979588 Mon Sep 17 00:00:00 2001 From: Xiao-Ran Zhou Date: Tue, 17 Sep 2024 17:47:08 +0200 Subject: [PATCH] Update README.md --- README.md | 33 ++++++++++++++++++++++++++++----- 1 file changed, 28 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 75bf11b..ee5188b 100644 --- a/README.md +++ b/README.md @@ -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)