Rev. 16-Feb-2006
The following checklist is provided as a reference for production level (i.e. v1.0 and beyond) software releases. Comments and feedback to Steve Olshansky <steveo AT internet2 DOT edu> and Ann West <awest AT internet2 DOT edu>.
Q: First Release of the Product? If no, skip Section A and proceed to Section B.
Section A: Product/Service Checklist
The list below is for reference only and is meant only to provide points to consider.
1. Branding/Legal Protection/Attributions
- Logo/logotype/wordmark and branding (in consultation with Internet2 Communications staff, other if co-branded)
- Design & production
- Trademark registered
- Usage guidelines
- License (currently all I2MI software is released under the Apache 2.0 license)
- Attributions
- Funding agency/contributors list
- Key development tools acknowledged (optional)
2. Communication/Support Tools
- Website content (Does not indicate organization, just content items project teams should consider when assembling a site.)
- Overview - what is it?
- News Pointers & Announcements
- Documentation
- Download page, containing links to source tarballs, CVS, Bugzilla
- (optional) precompiled binaries for common platforms: Wintel, Fedora Core, etc.
- (optional) binaries/code bundled with other code
- (optional) pre-packaged "demo" system allow someone to quickly install a running instance of the software for evaluation and experimentation in a non-production environment
- Project information
- Security Advisories
- Attributions
- Campus decision and deployment resources (i.e. testimonials, case studies, comparison tools, sample policies, etc.)
- Links to related projects, consultants, initiatives and tools (Could be add ons, monitoring tools, policy sites etc.)
- Project wiki - coordinate content which should reside on wiki, intended for collaborative input, v. more static content on website
- General Contact info (e.g. [foo]-info@internet2.edu, alias to project principals/flywheel)
- Supporting websites (NMI-EDIT, NMI etc.) for coordination
- Email lists
- Project Announce
- Working Group
- Users
- Who monitors lists? Users list is usually the primary public (peer) support mechanism, thus it is important for project developers to closely monitor this list and answer questions in a timely manner, particularly early in a project’s lifecycle. As a project matures and gains critical mass, other users can be expected to join in assisting users with questions/issues/problems.
3. Documentation
- Content/audiences
- FAQs
- Installation/Deployment Guide(s)
- Sys Admin Guide
- End-user Guide (if/as appropriate)
- Technical documentation: Toolkit, APIs, Customization (if/as appropriate)
- Migration doc (For releases other than the first one.)
- Architecture/specifications
- Development Roadmap
- Tear sheet/glossy
- See website content above
Section B: Release Process Checklist
- Date of release
- Hard or soft release? Internal or public? External drivers? (e.g. included in NMI release)
- If soft release, anticipated hard release date?
- Announcement
- Press release written
- Email announcement written
- Sent via which lists? E.g. MW-Announce, [Project]-Announce, I2-news
- Coordinate with orgs sending it out to their membership
- Audience identified and list assembled
- Software
- Release packaged and uploaded
- Demo packaged and uploaded
- Documentation
- Release notes/migration doc written
- Documentation (see above) updated
- Website/Wiki - coordinate content which should reside on wiki, intended for collaborative input, v. more static content on website
- Front page announcement added
- Release site altered – dedicated release page created and linked?
- Coordinating websites (e.g. NMI-EDIT etc.) updated
|
