<div><div dir="auto">Thanks Al! </div><div dir="auto"><br></div><div dir="auto">If you’re coming to PyCon next week I was thinking of doing a sprint on it for Monday or at least discussing it over the weekend. </div><div dir="auto"><br></div><div dir="auto">It’ll be difficult to get good audio of course, but I think I could write a standard specification in a day with enough people to discuss and collaborate</div><br><div class="gmail_quote"><div>On Sun, 6 May 2018 at 11:56 am, Al Sweigart <<a href="mailto:al@inventwithpython.com">al@inventwithpython.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div>This is something I'd be interested in contributing to as well, if we could lock down a good template and guidelines for them. I created something similar for Scratch in a series of videos called "Scratch Blocks in 60 Seconds": <a href="https://www.youtube.com/watch?v=ZCVb_EKTwQM&list=PL0-84-yl1fUki_zQ1ouwGN8t3spCTLnpS" target="_blank">https://www.youtube.com/watch?v=ZCVb_EKTwQM&list=PL0-84-yl1fUki_zQ1ouwGN8t3spCTLnpS</a></div><div class="gmail_extra"><br><div class="gmail_quote"></div></div><div class="gmail_extra"><div class="gmail_quote">On Fri, May 4, 2018 at 3:40 PM, anthony shaw <span><<a href="mailto:anthony.p.shaw@gmail.com" target="_blank">anthony.p.shaw@gmail.com</a>></span> wrote:<br></div></div><div class="gmail_extra"><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="auto">Hi</div><div dir="auto"><br></div><div dir="auto">I spend a lot of time reading the standard library documentation pages and then condensing them down into small videos as part of either commercial instructional courses or internal training. </div><div dir="auto"><br></div><div dir="auto">The problem is that all this work is isn’t much help to the PSF or the wider community. </div><div dir="auto"><br></div><div dir="auto">It’s my view that many people can sit and read the reference pages when they really need to check function or class documentation but beginners can find the pages stifling, with lots of new words, phrases and references to other stdlib modules. </div><div dir="auto"><br></div><div dir="auto">I was thinking of providing a set of templates and guidelines for having “5 minute overview” videos at the top of each standard library page. Videos would be embedded in the existing docs, starting with 3.7. </div><div dir="auto"><br></div><div dir="auto">Videos would first explain</div><div dir="auto">- why this module exists? What problem is it solving</div><div dir="auto">- core concepts and ideas</div><div dir="auto">- most basic usage examples with demos</div><div dir="auto">- where to find more information and other related modules </div><div dir="auto"><br></div><div dir="auto">Because modules change between minor versions, videos should not be a comprehensive guide to the module, but a starter guide for people unfamiliar with the module. </div><div dir="auto"><br></div><div dir="auto">The template, standards and guidelines for the creation of these video clips would live in the PSF documentation domain, as well as the review checklist and guidelines for adding them. </div><div dir="auto"><br></div><div dir="auto">Because many people would end up authoring the videos, consistency would be important, so a structured format and template is critical. </div><div dir="auto"><br></div><div dir="auto">I’m happy to volunteer to help create the template and guidelines. I know lots of teachers in the Python world who (hopefully) could start to contribute videos as well. </div><div dir="auto"><br></div><div dir="auto">Regards</div><span class="m_8471893104982143101HOEnZb"><font color="#888888"><div dir="auto">Anthony Shaw</div>
</font></span><br></blockquote></div></div><div class="gmail_extra"><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">_______________________________________________<br>
Doc-SIG maillist  -  <a href="mailto:Doc-SIG@python.org" target="_blank">Doc-SIG@python.org</a><br>
<a href="https://mail.python.org/mailman/listinfo/doc-sig" rel="noreferrer" target="_blank">https://mail.python.org/mailman/listinfo/doc-sig</a><br>
<br></blockquote></div><br></div>
</blockquote></div></div>