An Exploration of Inline Documentation and READMEs

In this article I explore the ways that computer programmers can make their code accessible to others through the use of well thought out written accompaniments to their code. I focus on inline documentation and README files.

I was drawn to this topic early on my journey into software engineering. Learning how to write code and share code is very interesting to me. My personal experience sharing documentation prior to becoming a software engineer included writing lesson plans, grant writing, editing documents, and creating reports for various nonprofits. Whether it was a document…

Yael Bassal

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store