The document provides tips for open source project maintainers on how to effectively communicate what their project is about to users. It advises determining who the target audience is and understanding their needs and perspectives. Project descriptions should use the same language as users, focus on specific outcomes rather than vague features, and be honest about the project's current capabilities rather than future plans. Maintainers should also differentiate their project from competitors and consider what core beliefs motivate it.
3. Have you ever encountered an open source
project you didn’t get?
4. Making sense matters.
• It’s a matter of respect
• People don’t use projects they don’t understand
5. Does my project have this problem?
• If you have to ask yourself….
• Do people ask weird questions about it?
• Do you get a lot of blank stares?
6. Help people get it.
• Talk to your users
• Use the same language your users do
• Focus on outcomes
• Be speci
fi
c
• Be honest
7. Know thy audience
You can’t talk about your project e
ff
ectively if you don’t know who the
audience is
8. What are your current users like?
• What pain are they experiencing?
• What outcome do they want?
• What do they compare you to?
• What do they believe?
9. What outcome do they want?
• Uncover relationships between your cloud resources
• Eliminate deployment delays due to broken dependencies
• Speed up iteration on your ML applications
11. Use same language as your users
• Category creation is possible! But hard, expensive and slow.
• “Creative phrasing” is usually just confusing
• Even within the bounds of established terminology, there could be multiple
accurate ways to describe your project. Which do your users prefer?
12. Be speci
fi
c
• Vague project descriptions help nobody
• Be short, but be speci
fi
c
• Leave out the things people don’t care about
13. Be honest
• It’s easy to accidentally misrepresent your project
• Talk about what you actually do now, not what you plan to deliver in 2
years
14. Three D Internet
The edge native platform
for distributed, local-first
applications
commercial IoT
development platform
Cloud service
company to
make IoT easier
15. We 3x the speed of
containerized I/O bound
applications
Revolutionize data
storage
Open source device
management
The lightweight,
programmable telemetry
platform for servers and
workstations
17. Bonus: Take a stand
Figure out what core beliefs motivate your project, and talk about them
18. Do you know what your project is?
• You need a noun to answer that question
• You should also have a more action, outcome-oriented way to talk about
your project —> a tagline, in other words
19. Now what?
• Write it down somewhere.
• Get all maintainers on board with how you’re going to talk about the
project.
• Update your website/docs/ReadMe
• See if you need to update your roadmap.