-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
36 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,43 @@ | ||
| ## Guidelines to develop materials | ||
| ## Guidelines to develop materials for HBC | ||
| (copied over from https://docs.google.com/document/d/1OhrFpQhBt4qb4R4LIm54VCc8cb_FZB3EWFcOO42giNU/edit) | ||
|
|
||
| ### Workshops | ||
| * Better deadlines that are met! | ||
| * Better coordination between developers | ||
| * Workflow development | ||
| * Meeting to overall workshop discuss flow/narrative and set deadline | ||
| * Develop lesson Draft 0 (complete at least 6 weeks before workshop) | ||
| * **Initial Meeting** to discuss overall workshop objectives, flow/narrative and set deadlines | ||
| * Develop lesson **Draft 0** (complete at least 6 weeks before workshop) | ||
| * Worked on by developer (not necessarily the person teaching) | ||
| * Mostly code with explanations as necessary (depends on developer) | ||
| * Mostly code with light explanations as necessary (depends on developer) | ||
| * No figures needed | ||
| * Code should be tested in a clean environment by developer (if possible) | ||
| * Develop lesson Draft 1 (complete at least 3 weeks before workshop) | ||
| * Others will work with developer on lessons they are potentially teaching to create Draft 1 from Draft 0 (which was presumably created by developer) | ||
| * Draft 1 definition | ||
| * Expanded explanations | ||
| * Figures added | ||
| * URLs to resources/papers added | ||
| * Code will have been tested by one other person | ||
| * Creation of a single md or R file with all the code (maybe) | ||
| * Review of full workflow (all lessons) by at least 2 people (complete at least 2 weeks before workshop) | ||
| * One person should test on teaching computer | ||
| * If feasible, test on PC | ||
| * Develop lesson **Draft 1** (complete at least 3 weeks before workshop) | ||
| * Developer creates placeholder markdowns for each individual lesson | ||
| * Each lesson should have header and learning obectives | ||
| * Include a section outlining in bullet points what code and content will be in this lesson. Be as speicfic as possible about your vision) | ||
| * Add sub-headers for sections you want to exist in the lesson | ||
| * Place the code and bare bones text in each lesson | ||
| * Assign it to an instructor to develop (set deadlines) | ||
|
|
||
| > #### Completed Draft 1 checklist (for each person assigned to a lesson) | ||
| > * Expanded explanations and narrative with good flow | ||
| > * Figures added with citations, if required | ||
| > * URLs to resources/papers added | ||
| > * All code will have been tested by one other person | ||
| > * Creation of a text/script file with all the code (maybe) | ||
| * Development of **Final Draft** | ||
| * Developer reviews all Draft 1 lessons | ||
| * Check for flow of the narrative | ||
| * All figures should be centered and formatted (appropriate sizing) | ||
| * Include additional figures if it is too text-heavy | ||
| * Make sure all hyperlinks work | ||
| * For advanced workshops, each lesson/step of workflow needs a workflow schematic at the top (under learning objectives) | ||
| * Each lesson should have CCBY attribution listed at the bottom (see existing lessons) | ||
| * Create a schedule page and link all lessons | ||
| * Include self-learning sections and pull-downs | ||
| * Add answer keys section | ||
|
|
||
| ### Fundamental/Basic Data Skills Workshops | ||
|
|
||
| ### Advanced NGS Analysis Workshops | ||
|
|
||
| ### Current topics in Bioinformatics (3 hour modules) | ||
|
|
||
| ### Modules (short workshops) | ||
| * |