Behind the scene: Writing tutorials
By Emmanuelle Delescolle
Who am I?
- An average developper
- Who loves working with Django
- A woman who codes
Contributing to opensource
What's your github account?
Can be:
Contributing to opensource
- organizing a conference
- triaging bugs
- writing documentation/tutorials
- maintenance (server/accounts/...)
- answering questions on forums/SO/IRC/...
- many other things
It can also be writing code and publishing it on github with an open-source licence
The matter at hand:
Writing tutorials or documentation
🎉 It's easy ! 🎉
$ python
Python 2.7.12 (default, Jul 1 2016, 15:12:24)
[GCC 5.4.0 20160609] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> print 'Hello world'
Hello world
>>>
You're not writing for yourself
Who are you writing for?
Someone with basic programming knowledge
People with experience in C
Windows users
Mac users
*nix users
Someone with web development knowledge
Someone with a scientific background
Teachers
Now that you know your audience...
The demo effect!
If you might be offended by swearing, please skip the next video
Questions
SyntaxError: Missing parentheses in call to 'print'Question
By Code Ninja on Sept. 18
Hey,
I tried running your code and I get this error:
Steps
Context
Recap
- Know your audiance
- Give more instructions than you might think necessary
- Break up your work into step (maybe different documents even)
- Make sure to always provide context to your audiance
- Try your tutorial/documentation for yourself