Talk Template

Use this template to structure your READMEs for talks. Remove text from this section, or use it to frame the talk you are giving. Good framing answers the question "Why am I learning this?".

Be sure to include a recent LICENSE and Markdown linter configuration (.remarkrc). Also, include an appropriate .gitignore; these are usually found in specific technology templates, for example js-template.

Prerequisites

• Topics with which developers should be familiar with.
• Prerequisites are "just-in-time", so if I have a prerequisite that mentions Sass, I would not need to include CSS as a prerequisite.
• Links to previous materials are often useful.

Objectives

By the end of this, developers should be able to:

• Write objectives that focus on demonstrating knowledge.
• Write learning objectives that begin with an imperative verb.
• Avoid objectives that start with "Use" or "Understand".
• Rewrite objecives that begin with "Use" by inverting sentence structure.
• End each objective with a period.
• Write objectives on the whiteboard so they can be referenced during a talk.

Preparation

1. Fork and clone this repository. FAQ
2. Create a new branch, training, for your work.
3. Checkout to the training branch.
4. Install dependencies with npm install.

Better preparation instructions may be found as snippets.

It's a good idea to have students do these steps while you're writing objectives on the whiteboard.

Leading Topic Heading

Here is where the talk begins. If you have not already included framing above, it's appropriate to put it here. Link to introductory articles or documentation. Motivate the next section.

Demos, exercises, and labs are labelled as such, followed by a colon and a description of the activity starting with an imperative verb.

Demo: Write a Demo

Demos are demonstrations, and developers should give their full attention to them. It's a great time for them to take notes about important concepts before applying them in an exercise.

Demos correspond to the "I do" portion of scaffolding from consultant training.

Code-Along: Write an Code-Along

During the code-along, developers should apply concepts covered in the previous demo, led by the consultant. This is their first chance to generalize concepts introduced. Exercises should be very focused, and flow natural into a lab.

Exercises correspond to the "We do" portion of scaffolding from consultant training.

Lab: Write a Lab

During labs, developers get to demonstrate their understanding of concepts from demos and applied knowledge from exercises. Labs are an opportunity for developers to build confidence, and also serve as a diagnostic tool for consultants to evaluate developer understanding.

Labs should be timed explicitly using a timer. When estimating the time it will take to complete a lab, it is better to overestimate. During labs, consultants should circle the room and interact with developers, noting patterns and prompting with hints on how to complete the lab. If developers end early, a consultant may stop the lab timer. If developers do not finish in time, a consultant may give more time at her discretion based on current talk pace, the current estimate for the talk, and the importance of completing the lab while consultant support is available.

Labs correspond to the "You do" portion of scaffolding from consultant training.

Additional Resources

• Any useful links should be included in the talk material where the link is first referenced.
• Additional links for further study or exploration are appropriate in this section.
• Links to important parts of documentation not covered during the talk, or tools tangentially used but not part of the focus of the talk, are also appropriate.

License

1. All content is licensed under a CC­BY­NC­SA 4.0 license.
2. All software code is licensed under GNU GPLv3. For commercial use or alternative licensing, please contact legal@ga.co.