search

chexxor / purescript-documentation-discussion

A place to organize the planning of improvements to the PureScript documentation.
7 stars 0 forks source link

Analyze 'Teach, don't Tell' #30

Closed JordanMartinez closed 5 years ago

JordanMartinez commented 5 years ago

This one is similar to the 'what they don't tell you about documentation'. It was included in one of the comments in #19

http://stevelosh.com/blog/2013/09/teach-dont-tell/

JordanMartinez commented 5 years ago

Context:

One of the best pieces of writing on this topic ever is Steve Losh's Teach, Don't Tell. It's a story-driven account of the failures that happen due to the lack of each of these types of documentation. Like everything Steve writes, it's worth the time to read.

JordanMartinez commented 5 years ago

This might be another one of those sources we don't 'analyze' because it's well written. Similar to #18 I have yet to read through it so I don't know how true this statement is.

JordanMartinez commented 5 years ago

It was similar to what the other document said. Still, there were some new ideas in it.

Closed by 16ef69100e8f500e43d31f7cbedb41fcd4a18c52

JordanMartinez commented 5 years ago

Apparently, I forgot to close this issue...