External documentation links
|Deletions are marked like this.||Additions are marked like this.|
|Line 16:||Line 16:|
| * ["Marketing documentation"] consists of materials intended to attract potential users
* ["User documentation"] consists of materials aimed at guiding users through common tasks.
* ["Governance documentation"] contains materials aimed at showing users and developers how to contribute to the project
* ["Developer documentation"] consists of materials aimed at helping people improve the software and its documentation
| * MarketingDocumentation consists of materials intended to attract potential users
* UserDocumentation consists of materials aimed at guiding users through common tasks.
* GovernanceDocumentation contains materials aimed at showing users and developers how to contribute to the project
* DeveloperDcumentation consists of materials aimed at helping people improve the software and its documentation
Like all pages in this wiki you are welcome (and encouraged) to contribute to this page by filling in the many gaps, either by providing links to other resources or by providing discussion content.
Open Source Development
There is more to open source than a licence. It is also a development methodology. This page links to various resources about different aspects of open source development.
Documentation is key to the success of your project. If your users can't use the software then they will simply leave. If your potential developers do not know how to contribute they simply won't bother.
MarketingDocumentation consists of materials intended to attract potential users
UserDocumentation consists of materials aimed at guiding users through common tasks.
GovernanceDocumentation contains materials aimed at showing users and developers how to contribute to the project
DeveloperDcumentation consists of materials aimed at helping people improve the software and its documentation
[http://www.symphonious.net/2007/02/06/creating-great-documentation/ Creating great documentation]
[http://norman.walsh.name/2007/02/05/painting Topic oriented authoring]
[http://www.wikipatterns.com/display/wikipatterns/Wikipatterns Wiki patterns]
["SVN Commit Messages"] - SVN can send out emails on every commit, great for peer review and keeping up to date
SoftwarePatch - Working with patches
ContributorLicenceAgreements - a contributor licence agreement helps ensure that all contributions to the project can legally be included
Quality is key. This does not mean shipping without bugs, that is close to impossible, what it does mean is shipping with no known bugs (actually shipping early releases with known. but manageable bugs can be ok too). Testing is the way to ensure you are shipping (near) bug free code. Testing falls into two camps, user testing and automated testing. Both have their strengths and weaknesses.
[http://tapestryjava.blogspot.com/2007/05/free-and-excellent-code-coverage-for.html EMMA] code coverage plugin for Eclipse
Release Early, Release Often
An important part of open source development is the creation of a release for users of the software. Whilst the source code is freely available and usually developed in an open manner, potential developers and users will usually want to be able to evaluate the code quickly and easily. Therefore, projects should frequently release their software in a form that is easily accessible.
"Release early, release often" is a well known mantra of open source development. There are many reasons why it is important to release early and release often. Some of the more important ones are:
- Early and frequent feedback from users
- easy access to the latest and greatest features
- Builds developer confidence
- Shows genuine project activity
- Manageable upgrade path for users
Release Early, Release Often is part of building a sustainable open source project, releases produce users, users sometimes become contributors, contributors make the project stronger. The downside of releasing early and often is that you need to manage your user expectations. Be clear about the true status of your release and make any known bugs clear in your documentation.
[wiki:ReleasingOpenSourceSoftware Releasing Open Source Software]
[http://en.wikipedia.org/wiki/Release_Management_method Wikipedia on Release Management Method]
[http://www.ics.uci.edu/~wscacchi/Papers/Open-Source-Research/OSSE3-Erenkrantz.pdf Release Management Within Open Source Projects by Justin R. Erenkrantz]
[http://www.tldp.org/HOWTO/Software-Release-Practice-HOWTO/ Software Release Practice HOWTO by Eric Steven Raymond]
You should make the installation of your software as easy as possible, ideally users should be able to download and install from a binary, whilst developers should have a clear document describing how to configure their environment.
IzPack - an installer generator for the Java platform.