Unfortunately, good code won't speak for itself. Even the most elegantly designed and well-written codebase that solves the most pressing problem in the world won't just get adopted on its own. You, the open source creator, need to speak for your code and breathe life into your creation. That's where technical writing and documentation come in. A project's documentation gets the most amount of traffic, by far. It's the place where people decide whether to continue learning about your project or move on. Thus, spending time and energy on documentation and technical writing, focusing on the most important section, "Getting Started," will do wonders for your project's traction.
code quality
See the following -
How To Write Effective Documentation For Your Open Source Project
By Kevin Xu | March 12, 2020
Why Implanted Medical Devices Should Have Open Source Code
By James H. Hamlyn-Harris | October 4, 2016
As medical implants become more common, sophisticated and versatile, understanding the code that runs them is vital. A pacemaker or insulin-releasing implant can be lifesaving, but they are also vulnerable not just to malicious attacks, but also to faulty code. For commercial reasons, companies have been reluctant to open up their code to researchers. But with lives at stake, we need to be allowed to take a peek under the hood. Over the past few years several researchers have revealed lethal vulnerabilities in the code that runs some medical implants.
- Login to post comments