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.
Kevin Xu
See the following -
3 Metrics To Measure Your Open Source Community Health
By Kevin Xu | March 21, 2020
Community building is table stakes in the success of any open source project. Even outside of open source, community is considered a competitive advantage for businesses in many industries—from retail, to gaming, to fitness. (For a deeper dive, see "When community becomes your competitive advantage" in the Harvard Business Review.) However, open source community building—especially offline activities—is notoriously hard to measure, track, and analyze. While we've all been to our fair share of meetups, conferences, and "summits" (and probably hosted a few of them ourselves), were they worth it? Did the community meaningfully grow? Was printing all those stickers and swags worth the money? Did we collect and track the right numbers to measure progress? To develop a better framework for measuring community, we can look to a different industry for guidance and fresh ideas: political campaigns.
- Login to post comments
3 Steps For Product Marketing Your Open Source Project
By Kevin Xu | February 15, 2020
Product marketing for COSS is materially different from product marketing for proprietary software and from general marketing practices like ads, lead generation, sponsorships, booths at conferences and trade shows, etc. Because the source code is open for all to see and the project's evolutionary history is completely transparent, you need to articulate—from a technical level to a technical audience—how and why your project works. Using the word "marketing" in this context is, in fact, misleading. It's really about product education. Your role is more like a coach, mentor, or teaching assistant in a computer science class or a code bootcamp than a "marketing person."
- Login to post comments
A Framework For Building Products From Open Source Projects
By Kevin Xu | November 26, 2019
If your experience with technology resembles mine in any way, you know intuitively that the projects we DIY are not the same as the products we spend money buying. This isn't a new observation in the open source community...Sarah Novotny, who led the Kubernetes community and was heavily involved in the Nginx and MySQL communities, emphatically articulated at the inaugural Open Core Summit that the open source project a company shepherds and the product that a company sells are two completely different things. Yet, project and product continue to be conflated by maintainers-turned-founders of commercial open source software (COSS) companies, especially (and ironically) when the open source project gets traction. This mistake gets repeated, I believe, because it's hard to mentally conceptualize how and why a commercial product should be different when the open source project is already being used widely.
- Login to post comments
How To Write Effective Documentation For Your Open Source Project
By Kevin Xu | March 12, 2020
- Login to post comments
Improve Open Source Community Sustainability By Tracking These Two Metrics
By Kevin Xu | November 12, 2020
In early 2020, I wrote an article on three metrics for tracking and measuring offline, in-person community-building activities. Little did I (or the world) know then that offline, in-person activities of any kind would soon become unfeasible for the foreseeable future. So, I started thinking: With open source projects being online by default, and with everything else moving online and virtual, what should creators of open source technologies measure as we continue in this COVID and (hopefully soon) post-COVID world? There are plenty of metrics you can track—stars, forks, pull requests (PRs), merge requests (MRs), contributor counts, etc.—but more data doesn't necessarily mean clearer insights. I've previously shared my skepticism about the value of these surface-level metrics, especially when assessing an open source project's health and sustainability. In this article, I propose two second-order metrics to track, measure, and continually optimize to build a strong, self-sustaining open source community...
- Login to post comments
Copyright ©2011-2020 Open Health Marketplace, LLC. All Rights Reserved.