Talks
Speakers
Events
Topics
Sign in
Home
Talks
Speakers
Events
Topics
Leaderboard
Use
Analytics
Sign in
Suggest modification to this talk
Title
Description
Learn Enough Tutorial Writing to Be Dangerous This talk discusses some time-tested techniques for producing effective tutorials, focusing on telling stories via long-form technical narrative. Topics include motivation & structure, the process of successive refinement (including the "comb-over principle"), and tricks of the trade for using neurological hacks and navigating large text files. The audience will leave with a stronger grasp of how to make tutorials that keep a reader's interest while instructing gracefully and effectively.
Date
Summarized using AI?
If this talk's summary was generated by AI, please check this box. A "Summarized using AI" badge will be displayed in the summary tab to indicate that the summary was generated using AI.
Show "Summarized using AI" badge on summary page
Summary
Markdown supported
The video titled 'Learn Enough Tutorial Writing to Be Dangerous' presented by Michael Hartl during the LA RubyConf 2015 focuses on effective tutorial writing techniques that leverage storytelling in technical narratives. Hartl, known for his work on the Ruby on Rails tutorial, provides insight into creating engaging instructional content aimed particularly at beginners. The talk centers around several key principles and methods to enhance the tutorial writing process. **Key Points Discussed:** - **Understanding Motivations:** Hartl emphasizes the importance of understanding the motivation behind each section of a tutorial to keep both the writer and the learner engaged. - **Structure is Key:** Effective tutorials have a well-thought-out structure that feels seamless to the reader. Knowing what to cover and when is a critical part of tutorial writing, helping to avoid overwhelming the student. - **Deferring Material:** Rather than explaining every concept upfront, Hartl advises deferring complex material for later, allowing readers to grasp fundamental ideas first without getting stuck on details. - **Use of Concrete Examples:** He advocates beginning with concrete examples prior to abstract concepts to facilitate better understanding, making tutorials more accessible for beginners. - **Repetition and the Spiral Method:** Repeating key concepts through varied examples reinforces learning, helping students to better retain information. - **Process of Successive Refinement:** Hartl shares a five-step process for writing tutorials which includes free association, content outlining, exposition, polishing, and iterating based on feedback to ultimately refine the content into a coherent tutorial. - **Visual Aids and Authorial Voice:** Incorporating visual elements and maintaining a consistent authorial tone throughout the tutorial are highlighted as effective techniques to enhance learner engagement. - **Finality is an Illusion:** Hartl encourages writers to understand that tutorial writing is an ongoing process; there’s always room for improvement and feedback is essential for evolution. In conclusion, Hartl’s final takeaway stresses the importance of shipping quality educational content while iterating based on learner feedback. He encourages aspiring tutorial writers to adopt a narrative-driven approach, emphasizing both clarity and engagement in their instructional materials. This philosophy not only aids the learner's understanding but enriches the overall experience of learning technical skills. His work, including upcoming tutorials under the 'Learning Enough' brand, aims to bridge the gap for complete beginners eager to dive into technical subjects.
Suggest modifications
Cancel
