|
5 | 5 | "id": "06e8fcaf-9d9a-4584-9747-d7129c96b31c",
|
6 | 6 | "metadata": {},
|
7 | 7 | "source": [
|
8 |
| - "# New Course Checklist and Timeline\n", |
| 8 | + "# New Course Checklist and Timeline \n", |
9 | 9 | "\n",
|
10 |
| - "## Timescales & Ordering\n", |
| 10 | + "## Timescales & Ordering \n", |
11 | 11 | "\n",
|
12 |
| - "### **12 weeks before delivery** \n", |
13 |
| - " - Hold initial logistics call with Programme Management to define learning objectives, course scope, and high-level timeline\n", |
14 |
| - " - Confirm roles (Developer, Lead, Helper) and schedule regular check-ins\n", |
15 |
| - " - Create a feature branch on the [CfRR_Courses repo](https://github.com/coding-for-reproducible-research/CfRR_Courses), alongside a GitHub Issue \n", |
16 |
| - " - Developer begins drafting core materials \n", |
17 |
| - "\n", |
18 |
| - "#### Checklist Steps \n", |
| 12 | + "### **12 weeks before delivery** \n", |
19 | 13 | "- [ ] Schedule and hold **initial logistics call** with Programme Management and Delivery Team \n",
|
20 |
| - "- [ ] Define roles: Developer, Leader, Helper, Participant, Programme Management, and schedule a recurring meeting \n", |
21 |
| - "- [ ] Open GitHub Issue for the new course; create feature branch \n", |
| 14 | + "- [ ] Identify delivery lead and delivery team members \n", |
| 15 | + "- [ ] Identify materials reviewer for **materials appropriateness** review (a subject matter expert who will assess whether the content is accurate, complete, and suitable for the intended audience; this review is separate from the functionality and accessibility review conducted later)\n", |
| 16 | + "- [ ] Define roles: Developer, Leader, Helper, Participant, Programme Management \n", |
| 17 | + "- [ ] Schedule recurring project check-ins \n", |
| 18 | + "- [ ] Open GitHub Issue for the new course; create feature branch in [CfRR_Courses repo](https://github.com/coding-for-reproducible-research/CfRR_Courses) \n", |
22 | 19 | "- [ ] Draft **course objectives** and detailed **learning objectives** for each section of the course\n",
|
23 |
| - "\n", |
| 20 | + "- [ ] Identify a high-level timeline for the delivery of the course \n", |
24 | 21 | "\n",
|
25 | 22 | "### **6 weeks before delivery** \n",
|
26 |
| - " - Submit the first complete draft of materials for internal review. Liam Berrisford (@liamjberrisford) to validate website functionality (including accessibility features), then a separate reviewer to verify that the course content itself is accurate and appropriate.\n", |
27 |
| - " - Draft metadata in `programme_information` and `section_landing_page` (titles, descriptions, prerequisites) \n", |
28 |
| - " - Create the “Where Is My Understanding?” quiz; confirm the quiz `JSON` files render via `JupyterQuiz`\n", |
29 |
| - "\n", |
30 |
| - "\n", |
31 |
| - "#### Checklist Steps\n", |
32 |
| - "- [ ] Populate `programme_information` \n", |
33 |
| - "- [ ] Populate `section_landing_page`\n", |
34 |
| - "- [ ] Populate `where_is_my_understanding`\n", |
| 23 | + "- [ ] Submit first complete draft of materials to the branch \n", |
| 24 | + "- [ ] Assign website functionality review to Liam Berrisford (GitHub: @liamjberrisford) \n", |
| 25 | + "- [ ] Assign materials appropriateness review to designated reviewer \n", |
| 26 | + "- [ ] Populate `programme_information` \n", |
| 27 | + "- [ ] Populate `section_landing_page` \n", |
| 28 | + "- [ ] Populate `where_is_my_understanding` quiz (`JSON` files confirmed to render via `JupyterQuiz`) \n", |
35 | 29 | "- [ ] Add course pages to `_toc.yml` \n",
|
36 |
| - "- [ ] Ensure no overlap or missing sections \n", |
| 30 | + "- [ ] Check for overlap or missing sections \n", |
37 | 31 | "- [ ] Test interactive plots, embedded HTML, and widgets \n",
|
38 |
| - "- [ ] Validate “Where Is My Understanding?” quiz (`display_quiz(\"path/to/quiz.json\")`) \n", |
39 |
| - "- [ ] Verify all file paths (spaces, special characters) are realtive paths as used in JupyterBook\n", |
40 |
| - "- [ ] Confirm images, data files, and HTML assets load correctly \n", |
41 |
| - "- [ ] Include slides or PDFs as needed; confirm static content links \n", |
| 32 | + "- [ ] Validate quiz rendering (`display_quiz(\"path/to/quiz.json\")`) \n", |
| 33 | + "- [ ] Verify all file paths use **relative paths** for Jupyter Book \n", |
| 34 | + "- [ ] Confirm all assets (images, data files, HTML) load correctly \n", |
| 35 | + "- [ ] Include slides/PDFs as required and confirm static content links \n", |
42 | 36 | "- [ ] Execute all notebooks end-to-end \n",
|
43 |
| - "- [ ] Peer-review code comments and markdown explanations \n", |
44 |
| - "\n", |
| 37 | + "- [ ] Peer-review code comments and markdown explanations \n", |
45 | 38 | "\n",
|
46 | 39 | "### **4 weeks before delivery** \n",
|
47 |
| - " - Confirm that all feedback and change requests from the internal review have been addressed\n", |
48 |
| - " - Link all assets (images, data files, interactive widgets) \n", |
49 |
| - "\n", |
50 |
| - "#### Checklist Steps\n", |
51 |
| - "- [ ] Confirm there is no outstanding feedback to be actioned from the internal review \n", |
52 |
| - "- [ ] Ensure that the Continuous Integration (CI) in the PR for building the Jupyter Book (website) and Accessibility passes\n", |
53 |
| - "\n", |
54 |
| - "\n", |
55 |
| - "### **2 week before delivery** \n", |
56 |
| - " - Freeze content; perform final proofreading and complete “top-to-bottom” code execution \n", |
57 |
| - " - Please notify Liam Berrisford (@liamjberrisford) that the content is ready for integration into the website and request his final review prior to publication.\n", |
58 |
| - " - Merge the feature branch and add the new course to the live website\n", |
| 40 | + "- [ ] Address all outstanding feedback from internal reviews \n", |
| 41 | + "- [ ] Confirm all assets are correctly linked and functional \n", |
| 42 | + "- [ ] Ensure Continuous Integration (CI) build for Jupyter Book passes, including accessibility checks\n", |
59 | 43 | "\n",
|
60 |
| - "#### Checklist Steps\n", |
61 |
| - "- [ ] Perform a final proofreading pass; execute a full “top-to-bottom” run of all notebooks \n", |
62 |
| - "- [ ] Notify Liam Berrisford (@liamjberrisford) that materials are ready for integration and request his final sign-off \n", |
63 |
| - "- [ ] Once approved, merge the feature branch into main and deploy the new course to the live website " |
| 44 | + "### **2 weeks before delivery** \n", |
| 45 | + "- [ ] Freeze content \n", |
| 46 | + "- [ ] Perform final proofreading and “top-to-bottom” notebook execution \n", |
| 47 | + "- [ ] Notify Liam Berrisford (@liamjberrisford) that materials are ready for integration into the website \n", |
| 48 | + "- [ ] Obtain final sign-off from Liam \n", |
| 49 | + "- [ ] Notify [Jenny McGarvey](https://libguides.exeter.ac.uk/prf.php?id=b1cb0409-e2fc-11ef-b755-0647746d9baf) of the upcoming course; specify that it will be available on the website in approximately 2 weeks. \n", |
| 50 | + "- [ ] Merge feature branch into main \n", |
| 51 | + "- [ ] Deploy course to live website " |
64 | 52 | ]
|
65 | 53 | },
|
66 | 54 | {
|
|
0 commit comments