Stop Building It From Scratch: Creating Reusable eLearning Components

Stop Building It From Scratch Creating Reusable eLearning Components presented by Chad Udell and Mark Tovey at DevLearn ’09 November 12th, 2009

Introduction

Introduction • Who we are

Introduction • Who we are • Where do we work

Introduction • Who we are • Where do we work • What do we do

Purpose

Purpose • Who is this presentation best suited for?

Purpose • Who is this presentation best suited for? • What will you learn?

Purpose • Who is this presentation best suited for? • What will you learn? • How can you implement it immediately?

A show of hands

A show of hands • Who has rebuilt a feature more than 2-3 times?

A show of hands • Who has rebuilt a feature more than 2-3 times? • Who has a library of snippets they refer to?

A show of hands • Who has rebuilt a feature more than 2-3 times? • Who has a library of snippets they refer to? • Who has used an API before?

A show of hands • Who has rebuilt a feature more than 2-3 times? • Who has a library of snippets they refer to? • Who has used an API before? • Who has created their own API?

Some observations

Some observations • Everyone keeps a folder or two around on their PC/Mac for their “best of” examples and code reuse

Some observations • Everyone keeps a folder or two around on their PC/Mac for their “best of” examples and code reuse • APIs are used a lot in other areas, almost never in eLearning (barring SCORM, of course)

Some observations • Everyone keeps a folder or two around on their PC/Mac for their “best of” examples and code reuse • APIs are used a lot in other areas, almost never in eLearning (barring SCORM, of course) • Version Control is used in other areas, too, almost never in eLearning

Key Differences between APIs and Libraries

Key Differences between APIs and Libraries • APIs are by deﬁnition, basically • A code “library” is always in ﬂux. stable. • Libraries may vary from developer • With an API, everyone shares the to developer same base • Libraries may have collisions • APIs are designed from a holistic between snippets view • Documentation? ha! • Documentation is key!

The problem with libraries.

The problem with libraries. • It’s impossible to establish coding conventions

The problem with libraries. • It’s impossible to establish coding conventions • Copy and Paste syndrome

The problem with libraries. • It’s impossible to establish coding conventions • Copy and Paste syndrome • Single source saves time

The problem with libraries. • It’s impossible to establish coding conventions • Copy and Paste syndrome • Single source saves time • Bugs recur

The problem with libraries. • It’s impossible to establish coding conventions • Copy and Paste syndrome • Single source saves time • Bugs recur • Teamwork is tough

What advantages does an API provide?

What advantages does an API provide? • Common, share-able code base (methods, properties, events)

What advantages does an API provide? • Common, share-able code base (methods, properties, events) • Extend as you need

What advantages does an API provide? • Common, share-able code base (methods, properties, events) • Extend as you need • Proven effectiveness/Productivity

What advantages does an API provide? • Common, share-able code base (methods, properties, events) • Extend as you need • Proven effectiveness/Productivity • Company Risk Management & Intellectual Property Protection

We need something better: Version Control

We need something better: Version Control • Revision History and Committing to a safe source.

We need something better: Version Control • Revision History and Committing to a safe source. • Needed for quality

We need something better: Version Control • Revision History and Committing to a safe source. • Needed for quality • Needed to help transition from a library to an API

What does version control provide?

What does version control provide? SVN=!OMG.

What does version control provide? • Risk Management SVN=!OMG.

What does version control provide? • Risk Management • Forks SVN=!OMG.

What does version control provide? • Risk Management • Forks • Team Collaboration SVN=!OMG.

What does version control provide? • Risk Management • Forks • Team Collaboration • Ease of deployment SVN=!OMG.

How can I get started?

How can I get started? • Make a list of common things you and your users routinely do. • LMS Connections • Bookmarking • Scenarios • Quizzes • L10N

Now what?

Now what? • Make a list of things you have done in the past that were painful • Getting content into/out of your LCMS • Sharing media pieces through the course • Integrating non-standard media • Exporting for multiple formats • Non-Linear/Non-Standard Navigation

Survey the landscape... What’s Flickr doing?

Survey the landscape... What’s Flickr doing? • Or Twitter for that matter?

Survey the landscape... What’s Flickr doing? • Or Twitter for that matter? • Take a quick look at some developer sites like programmableweb.com to see APIs you may want to emulate.

Key Tenets

Key Tenets • There are a number of overarching principles you should adhere to. • This isn’t meant to be dogmatic or inﬂexible, but merely a path to success

The Basics

The Basics • Keep your users in mind!

The Basics • Keep your users in mind! • Once you deploy it, it’s tough to change it.

The Basics • Keep your users in mind! • Once you deploy it, it’s tough to change it. • It can’t have everything in it!

The Basics • Keep your users in mind! • Once you deploy it, it’s tough to change it. • It can’t have everything in it! • It should be easy to learn, hard to abandon.

The Basics • Keep your users in mind! • Once you deploy it, it’s tough to change it. • It can’t have everything in it! • It should be easy to learn, hard to abandon. • People should see value in it immediately.

Some Rules of Thumb • Keep it small • Methods, Properties and Events • Can’t have a decent API with out all 3 • Don’t use abbreviations for functions or variables • It should be apparent what is going on without reading the docs.

Samples: Some Rules of Thumb • Example of Getter/Setter • Code sample with abbreviation vs. code without.

Key Concept: Predictability • Users shouldn’t be surprised by return values. • Users should be able to chain methods • Users should be able to call/access all methods/events at all times.

Samples: Predictability • Code Sample - Non Surprising return value • Code Sample - Chaining methods • Code sample - ﬂexible calling/returning

Key Concept: Supporting Ease of Development • A broader acceptance brings success • Uniform data input/output is easier • Arrays vs. Vectors – Using 0 vs. null • Provide meaningful errors • Compile time errors are better than runtime

Samples: Ease of Development • Code Sample on input/output • Code Sample on Compile time error vs Runtime error

That’s a lot... how do I do this? • It’s probably not practical on your own. • Focus on the end goal • Start with a solid code base... OOP helps. • The best tool to start with: A notepad.

On your own • Re-familiarize yourself with your library. • Catalog the best examples. • Throw the rest out.

During Development: Agility

During Development: Agility • Start small, build the best you can!

During Development: Agility • Start small, build the best you can! • Have a core set of methods you can chain to do something great, then grow.

During Development: Agility • Start small, build the best you can! • Have a core set of methods you can chain to do something great, then grow. • Don’t throw in the kitchen sink!

During Development: Starting Simple

During Development: Starting Simple Core

During Development: Starting Simple •Core •Should be focused on your key pain point(s) •Should have a clear ROI in mind Core

During Development: Starting Simple •Core •Should be focused on your key pain point(s) •Should have a clear ROI in mind Data Core

During Development: Starting Simple •Core •Should be focused on your key pain point(s) •Should have a clear ROI in mind •Data •Integrate with a CMS/XML/ etc. •Work with translators, etc Data Core

During Development: Starting Simple •Core •Should be focused on your key pain point(s) •Should have a clear ROI in mind •Data •Integrate with a CMS/XML/ etc. •Work with translators, etc Data Core Behavior

During Development: Starting Simple •Core •Should be focused on your key pain point(s) •Should have a clear ROI in mind •Data •Integrate with a CMS/XML/ etc. •Work with translators, etc Data Core Behavior •Behavior •Ease Development in a larger team •Expand rich media use/capabilties

Post development: Deploying

Post development: Deploying • Don’t circulate beyond friends until it’s ready

Post development: Deploying • Don’t circulate beyond friends until it’s ready • Compilation, Obfuscation and Minifying

Post development: Deploying • Don’t circulate beyond friends until it’s ready • Compilation, Obfuscation and Minifying • Hosting the API (Amazon, Sourceforge, etc)

Post development: Deploying Robot Picture

Post development: Deploying • Building Installers, SWC, MXP, etc. Robot Picture

Post development: Deploying • Building Installers, SWC, MXP, etc. • http://blog.ﬂashgen.com/ components/distribution/ Robot Picture distribution-via-mxp/

Post development: Deploying • Building Installers, SWC, MXP, etc. • http://blog.ﬂashgen.com/ components/distribution/ Robot Picture distribution-via-mxp/ • Creating Docs (ASDocs, JSDocs, JavaDocs)

Post development: Deploying • Building Installers, SWC, MXP, etc. • http://blog.ﬂashgen.com/ components/distribution/ Robot Picture distribution-via-mxp/ • Creating Docs (ASDocs, JSDocs, JavaDocs) • Automating Builds

• Building an API is tough work, but VERY rewarding

• Building an API is tough work, but VERY rewarding • For more information check out the sites listed in the handout, downloadable at the DevLearn Site.

• Building an API is tough work, but VERY rewarding • For more information check out the sites listed in the handout, downloadable at the DevLearn Site. • Contact us: chadu@ionagroup.com, mtovey@ionagroup.com

Stop Building It From Scratch: Creating Reusable eLearning Components

0 comments

Notes on slide 1

Favorites, Groups & Events