I know this isn’t news, but it’s something I’ve dreamed of for a long time. Finally, a group has taken it upon themselves to make it a reality for an important software project.
I’m commenting on this because I think every project should have something similar. And I’m not just talking about software projects, either; this kind of thing is equally relevant to any project, regardless of size or type.
Key things to include:
- The current state of the project
- Where the project is headed
- Where the project is not headed
- Where the project might be headed
All of the above should be broken down for any sub-projects. Now, what have I left off? Notably the high-level goals of the project, and its background. I’m not suggesting that these are unimportant, but they can go elsewhere.
Why is this so important? It gives a great overview of what the project is, and what it aims to be in future. It gives potential developers a lot of information at a glance that they can use to decide whether they might be interested in contributing, and how they could go about doing so. Developers from other related projects can more easily see how it might relate to their project, and how they might better work with your project. It can generate interest and exposure, and stop your project from being a confusing black box to outsiders.
Note that the Linux Weather Forecast doesn’t read like an advertisement. Its purpose is to inform — not to boast about how great Linux is, how it can lower your TCO, or any other such waffle. It is simple and to the point, and that’s why it is so great.
With any luck, other large projects will notice this and follow suit.
No comments:
Post a Comment