Audience
last updated 2 years ago by chrisn #
This page is not part of the tutorial. Inline comments are okay!
What it is, and what it isn't.
The tutorial is an introduction to Python, not an introduction to programming.
This means that, in general, things shouldn't be left out or glossed over just because they might be confusing to "newbies" or non-programmers. On the other hand, the tutorial shouldn't assume that everyone knows lots of other programming languages, or computer science, or math, or understands advanced english or monty python arcana well.
(more stuff to be added later; there are several good comments on this topic scattered around this site, but my net connection is too shaky right now to be really usable... /F)
(chrisn) It would be nice if there could be markings for the different audiences. A paragraph explaining a technicality might be very interesting to some, but not all. A visual marking would make it easier to skip over for beginners. Is there a way to do that, or to implement that?
re: 'Is there a way to do that'?
I think everybody is familiar with hypertext now. So it is possible to write your documentation in a style that skips the technicalities, but when you mention them make a link, and get the technicality when you click on the link. I think footnotes should mostly be done that way as well. Sometimes this is not desirable, i.e. if you want people to read code and look at a diagram at the same time.
lac 2 years ago #