Hacker News new | past | comments | ask | show | jobs | submit login
Writing a Friendly README – a short guide on user-focused documentation (rowanmanning.com)
5 points by rowanmanning on March 15, 2016 | hide | past | favorite | 2 comments



He neglects to mention the new trend of adding images and in particular screen caps with animated gifs. In my opinion this new trend has been a major improvement to READMEs. I can often just watch the demo to both understand what it is and even how to use it. This helps since I'm often too lazy to read the whole thing.


You may have not noticed with the current Node.js fad, but README does not constitute a documentation. README is just a description of the project, along with some contact information.




Consider applying for YC's Spring batch! Applications are open till Feb 11.

Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: