1
How I Judge the Quality of Documentation
As a developer, you develop instincts for judging quality of code. One of my favorite interview questions is: When you look at a project’s code for the first time, what are the things you look for?...
Eric Holscher
Hi! I’m Eric. I build documentation tools and communities, and otherwise spend time outside. I co-founded Read the Docs, Write the Docs, EthicalAds, and PyCascades. This site covers a long history ...
- Popular posts
- 3
- Total points
- 327
- HN comments
- 230
- Rank
- #8,191 personal
Visit ericholscher.com → RSS feedOn Hacker News Nov 2010 – Mar 2016
Software Engineering 3Tools & Productivity 2Life, Learning & Writing 1
2
Don’t Use Markdown for Documentation
“Markdown” is the most commonly used lightweight markup language on the internet. It is great for a subset of tasks, mainly blog posts and commenting. However, lately it has been adopted by the tec...
3
Required Reading (for pythonistas)
At work, we have a wiki page that’s called Required Reading. Named after that oh-so-lovely tradition in high school or college of having books that you needed to read over the summer before you sta...