(pulled from 2016 OLTS and live verion at https://mozilla.github.io/open-leadership-training-series/articles/opening-your-project/write-a-great-project-readme/)
Who you’re working with, or hope to work with What you’re doing Who you’re doing it for, your audience (may be same as b) Why you’re this, the impact or change you hope to make
Use the information you gathered in the Open Canvas exercise as a starting point. Be sure to:
- Say hello! Welcome people to the project. It’s great to introduce yourself here, so people know they’re dealing with a person or group of real people. Let potential contributors know you’re excited that they’re here to learn more
- Write a project description: what you’re doing, with who, for who, and why. Sound familiar? This is a version of your project vision. Expand your sentence as a full paragraph, adding any new details about aims and the problems you plan to solve that surfaced in the Open Canvas activity. Try to phrase this so it’s understandable and appealing to a wide variety of people, not just those in your field.
- Explain what makes your project special, useful, exciting! You can use the ideas you generated for “Unique Value Proposition” in your Open Canvas here.
- Show how to get started using or contributing to the project. If you’re just getting started, this could be as simple as asking people to attend a planning call or kick-off event, or sign up for an email newsletter about the project. If you’re not sure quite how to get users involved just yet, don’t worry! In the next module, you’ll devise some ways for newcomers to get involved, and create contributor guidelines. Once you’ve done the next module, and you can come back to this README and add a link to contributor guidelines to this section.
- State what resources are most needed. If you have a need for a special kind of help, expertise, or a resource like event space, be sure to mention that here.