Add page for README/docs inspiration - Githubissues

LappleApple / feedmereadmes

Free README editing+feedback to make your open source projects grow. See the README maturity model to help you keep going.

Creative Commons Attribution 4.0 International

1.13k stars 56 forks source link

Add page for README/docs inspiration #16

Closed LappleApple closed 6 years ago

LappleApple commented 7 years ago

With links:

http://www.ybrikman.com/writing/2014/05/05/you-are-what-you-document/
https://www.hanselman.com/blog/BringKindnessBackToOpenSource.aspx
How to Write Documentation for People that Don't Read: https://www.youtube.com/watch?v=sQP_hUNCrcE
http://hilton.org.uk/presentations/documentation
http://codewerdz.org/
https://insights.hpe.com/articles/how-to-write-documentation-thats-actually-useful-1707.html
http://codewerdz.org/
http://blog.izs.me/post/161633971373/documentation-driven-development
Andrea Goulet: Communication is Just as Important as Code: https://www.youtube.com/watch?v=VFuNdKPV0jc&feature=youtu.be
https://www.youtube.com/watch?v=sQP_hUNCrcE
Slides: kev.inburke.com/slides/documentation

LappleApple commented 6 years ago

Done.

janpio commented 6 years ago

If anyone is looking for the result as I did: https://github.com/LappleApple/feedmereadmes/blob/master/Inspiration.md

Looking good!