Software Applications
What I would like to see for Software Application pages is a layout along the following lines. Note that these sections should always appear in this order, with the same content (where applicable).
Overview
A simple overview or introductory paragraph, explaining what the application is, what it is commonly used for, etc. This section should also incorporate the KB Icon for Software. For example:
Adobe Photoshop CS4, often referred to as simply Photoshop, is a graphics editing program developed and published by Adobe Systems. It is described as a tool for perfecting digital images and is ideal for professional photographers, serious amateur photographers, and graphic designers. Photoshop can be purchased either standalone or as part of Adobe's Creative Suite 4 software.
Contents
Standard Table of Contents, created from and providing links to all Heading 2, 3, 4 sections.
Product Details
A summary of the specifics of the product.
- Full name e.g. Adobe Photoshop CS4
- An up-to-date logo or product image
- Publisher, including a link to the publisher's home page e.g. Adobe Systems
- A link to the product's home page e.g. Adobe Photoshop Website
- A link to the publisher's FAQ/Tips/Manual for this specific product e.g. Adobe's Photoshop Help and Support
System Requirements
A summary of system requirements and a link to the publisher's full list.
Licensing Information
A summary of licensing information (examples: this product is available under the GPL or Carleton owns 20 individual copies of this software)
Licensing Restrictions
Examples: This license is restricted to a specific building, department, or to a single-user on a single machine
Usage Restrictions
Examples: This software is for non-commercial use
Home Use
Examples: Faculty and staff can install this software on one personal computer. It must be the same version that is installed on their college-owned computer.
Lab and Classroom Availability
Adobe Photoshop for Mac and Windows is available in all refreshing labs and classrooms. For a complete list, click here
Installation Instructions
Labs and Classrooms
To request this software be installed on a refreshing lab/classroom contact xxx
Link to protected information for how we configured it to work
College Owned Equipment
If users can self-serve this software, enter instructions here.
Link to protected information for ITS instructions
Personal Machines
Instructions for installation/registration
§ A download link. This will probably be one of two types: either the Carleton hosted link, such as those for McAfee, Mulberry, etc.; or a download page from the publisher’s site; or, I suppose, both. I would like this to include some (brief) text indicating with is being offered
Who To Call
We should talk about this one. We have a request to include who customers / customer groups (Faculty, students, ITS staff) should go to for support questions. I think the idea is that, if RR get a call from e.g. faculty on the application and RR don't have the answer, the RR staff know who in ITS to ask for the answer.
Questions, Tips and Tricks
The meat and potatoes of the page. Base content should draw from the all existing Wiki content, as well as Web Help Desk, personal experience and other folks in the department. Content can then be added based on questions that we commonly receive, or questions that arise as the result of curricular assignments.
Note: In places where step-by-step instructions are appropriate, I would like them written as numbered steps rather than bulleted or as fluent written English. The latter is impractical for the user to follow. The former makes it easier to track where in the process you are. Using numbers also allows you to use bullets for multiple points within a step if necessary.
Technical Troubleshooting
This section should only address (potential) technical problems with the application e.g. Photoshop will not launch because of a licensing error. The content should either be instructions on how to resolve the problem, or who to contact to report and/or resolve the problem. Formatting should be basically identical to Questions, Tips and Tricks, and is likely to have more step-by-ste
Some of this information may be restricted. Place a link to that here. A good rule of thumb is this: If you are getting troubleshooting information from a public vendor knowledge base, there isn't any reason to restrict it. If you are getting your information from a password protected knowledge base, or any warez site, it should be protected.
Miscellaneous Information
...