improving shareability and maintainability for short ...€¦ · improving shareability and...

1
Improving Shareability and Maintainability for Short Training Workshops The Project Convert workshop training content from PowerPoints, PDFs, code scripts, and text files to a GitHub Pages online training resource while incorporating best practice pedagogy Why Easier for new instructors Simpler correction and updating of material Allows multiple delivery options Supports sharing of training content The Benefits Provides a fully self-contained training resource Encourages a focus on better learning outcomes Edits can be made in just a few minutes Any trainer (or user) can submit edit requests The Challenges Conversion takes 1-2 days per day of content Data scientists may need guidance to structure lessons Training specialists may need guidance in technical content Can’t restrict access (may be possible with other hosts) The Process High level review of existing workshop content Split into topic sections (“Episodes”) Define learning objectives – three to five for each episode Order learning objectives into progressively advancing steps Develop challenges and code examples towards each objective Break down theory sections and match with corresponding objectives, challenges and examples Merge content from existing sources into episode markdown documents Integrate to Software Carpentries Jekyll theme 1 and display on GitHub Pages 1 - https://github.com/carpentries-i18n/carp-theme Mark Crowe , Justin Scott, Anne Bernard QCIF, Brisbane, Australia [email protected]

Upload: others

Post on 07-Oct-2020

3 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Improving Shareability and Maintainability for Short ...€¦ · Improving Shareability and Maintainability for Short Training Workshops The Project Convertworkshop training content

Improving Shareability and Maintainability for Short Training Workshops

The ProjectConvert workshop training contentfrom PowerPoints, PDFs, code scripts, and text files to a GitHub Pages online training resourcewhile incorporating best practice pedagogy

Why• Easier for new instructors• Simpler correction and updating of material• Allows multiple delivery options• Supports sharing of training content

The Benefits• Provides a fully self-contained training resource• Encourages a focus on better learning outcomes • Edits can be made in just a few minutes• Any trainer (or user) can submit edit requests

The Challenges• Conversion takes 1-2 days per day of content• Data scientists may need guidance to structure lessons• Training specialists may need guidance in technical content• Can’t restrict access (may be possible with other hosts)

The Process• High level review of existing workshop

content• Split into topic sections (“Episodes”)

• Define learning objectives – three to five foreach episode

• Order learning objectives into progressively advancing steps

• Develop challenges and code examples towards each objective

• Break down theory sections and match with corresponding objectives, challenges and examples

• Merge content from existing sources into episode markdown documents

• Integrate to Software Carpentries Jekyll theme1 and display on GitHub Pages

1 - https://github.com/carpentries-i18n/carp-theme

Mark Crowe, Justin Scott, Anne BernardQCIF, Brisbane, Australia

[email protected]