瀏覽代碼

include workshop feedback in the template

julien colomb 2 年之前
父節點
當前提交
14a60c8405
共有 3 個文件被更改,包括 56 次插入13 次删除
  1. 10 1
      02_material_and_methods/README_MM.md
  2. 26 1
      03_data/README_DATA_STORE.md
  3. 20 11
      README.md

+ 10 - 1
02_material_and_methods/README_MM.md

@@ -1,3 +1,12 @@
 # Content
 
-Please provide a summary of the content of this section and update it properly.
+## Hardware details
+
+For self-built hardware, it is recommended to have a special repository for its description and link it with a URL or as a submodule here. For any hardware, you should provide a user guide with the following information:
+
+- How to check the hardware is working: calibration, validation
+- Troubleshooting guide, common issues
+- What was bought were?
+- What was custom-built, by whom and how ?
+- Critical hardware parts, what could be modified?
+- Schematics and/or photos (lots of photos)

+ 26 - 1
03_data/README_DATA_STORE.md

@@ -1,3 +1,28 @@
 # Content
 
-Please provide a summary of the content of this section and update it properly.
+This readme contains a summary of information you should provide about your data. This is mostly meant as a checklist, as the information should be best included in the readme of the data folders or in the data management plan.
+
+# List of experiments
+
+## 001
+
+### Hardware/tool used for acquisition
+
+### protocol
+
+- Standard procedure
+- Glossary/definition of terms (for categorical variables)
+- What changed, when and why
+- Techniques that were tested but not chosen, and why
+
+### raw data description
+
+- how does good/reliable data look like
+- exclusion criteria
+- data flow. What type of data is collected when
+- headers description, how to interpret the data
+
+### data analysis
+
+- analysis workflow
+- code versions

+ 20 - 11
README.md

@@ -2,7 +2,11 @@
 
 ## Abstract, vision and goals
 
-## Roadmap and Milestones
+## Project status
+
+### Roadmap and Milestones
+
+### Successes and failures
 
 ## Contributors
 
@@ -10,24 +14,29 @@
 
 [Mention your contributors either by including a contributors list here, or by referring to another file that lists your contributors, see documentation for options and examples. It is good practice to set roles for each contributor at the start of the project and discuss author byline of a future paper early.]
 
-## List of experiments
+## Experiments
 
 ### 001
 
-raw data consists of..., its format is ..., it is organised following own organisation (specify) / standard X
-derived data consists of..., its format is ...,
+FIX: short description, 
+details at [03_data/README_DATA_STORE](03_data/README_DATA_STORE)
+and/or in the data management plan: [01_project_management/05_data_management_plans](01_project_management/05_data_management_plans).
 
-## Direct links (inside or outside this repository)
+## Communication
 
 - todo list: [use issues](../../issues)
-- data management plan: [01_project_management/05_data_management_plans](01_project_management/05_data_management_plans)
-- Smartfigure tag: [YOURTAG](https://sdash.sourcedata.io/?q=YOURTAG) [FIXME:replace YOURTAG in the url and the text.]
-- Main Communication channel: FIXME
+- minutes: [01_project_management/03_meeting_minutes](01_project_management/03_meeting_minutes)
+- Communication tools and email archive:
 
-## Other information
+## Outreach and external links
+
+- Smartfigure tag: [YOURTAG](https://sdash.sourcedata.io/?q=YOURTAG) [FIXME:replace YOURTAG in the url and the text.]
 
-**Note:** This repository follows the Research repository template, v.2.3, see [further information offline](.doc/information.md) or [the online documentation page](https://gin-tonic.netlify.app/).
 
 ## Contribution
 
-If you are new to this project, familiarise yourself with the vision, set your own role and responsibilities with the team, and read the data management plan. Make sure your contributions can be understood and reused by other members of the team.
+If you are new to this project, get familiar with the vision, set your own role and responsibilities with the team, and read the data management plan. Make sure your contributions can be understood and reused by other members of the team.
+
+## Technical note
+
+**Note:** This repository follows the Research repository template, v.2.4, see [further information offline](.doc/information.md) or [the online documentation page](https://gin-tonic.netlify.app/). Do not modify folder name unless you are sure of what you are doing.