Implementation aspects will be discussed, but not details - only the general framework.
The project that I am going to describe will be a miniature version of Post'em!.
The user documentation was developed with Greg Hanek when he was a GA in our office (The Bureau of Evaluative Studies and Testing (BEST) at IU).
I won't post too much here before the lecture but I will probably post a summary with conclusions afterwards.
1. Identify a problem to be solved.
Do it for the purpose of communicating the problem to me. Don't identify problem with necessity. By problem we mean a certain kind of service that we provide. Some services are more important and/or more necessary/vital than others. Your project idea will have an identity of its own. Describe it.2. Identify your users
Users are those that work with your system. Those could be end-users or administrators like you. Distinguish further if you can between your end-users (instructors/students, readers/writers, consumers/producers).3. Describe your solution.
2.1 Are your users going to have an identity of their own?Are you going to be able to distinguish between your users, individually? If so describe the method that you will use to achieve that. In most situations this is done via a username/password authentication method. If you will use such a method think of where you keep the passwords.2.2 Are there any issues of privacy/security?
A related question is: do you let the users create their own identity (such as when you register for New York Times) or do you require that they apply for an account (such as when an IUB network ID is created).
Describe what kind of data users can input to your site and any levels of access that your application will require. For example if you are building hotmail.com or mailexcite.com you probably want users to read only the mail addressed to them and nothing more. A grade and feedback posting system also has to provide a certain specific level of security and privacy.
Assume you're trying to sell your system to a potential client, company, or service provider.4. Address issues of implementation.
3.1 Describe all user interfaces.3.2 Contrast your solution to the way that service is currently provided (if not a new service).
This, I believe, is the most important part of your proposal.
Explain to your client what each of the category of users assumed by your system can do. Be fairly detailed as if you'd be running that person through a sequence of demo screens.
Note that if your system is part of another bigger system (which may take care of the user interface) then this requirement translates into: describe its input/outputs, and any internal states it may have.
For example when we post grades with a feedback system we are trying to provide a better or faster service. This is not a new service but features of the service are new (the privacy issue comes to mind).
If your service is a new service (loosely speaking) explain what's the novelty of it, as you're trying to sell it.
Try to describe each of the actions that the user interface can generate in terms of smaller, simpler steps, that would be closer to how your system will work. Your framework is a client/server approach, with a network link between the server and the client.5. Address issues of capacity planning.
On the server side the programming is mostly done through CGI although you can write your own perl and/or java server (except that this way you're diminishing the role of Apache).
How many users are you going to have. What will be their work habits. Is your server going to be overloaded at any time. Is your service mission critical? What if it becomes unavailable at a certain time -- how would this affect your users? Are some times more important than others?6. Address issues of cost of maintenance and distribution.
6.1 MaintenanceHow many hours per month does it take to keep your service running. If someone will buy your system they will need to know what's going to take to keep it running. (User)6.2. Distribution
Is there an initial cost for populating the database on the server with the initial data for a certain client? (Service Provider)
What does your service require for the user workstation to be functional. If you're implementing using CGI with HTML forms then you assume that the user has a web browser installed.If you're using some browser specific functions mention them.
If you're writing a Java (or some other type of) application and expect the users to download and install it be aware of what they need and try to be precise about what they need to do.
If you're using applets or CGI with HTML forms you can almost assume that the user has a browser installed, and so the effort of distributing your client software will be close to zero.
However you need to keep in mind the trade-offs: custom-client software may be more powerful but it may require more work for the client (installation) and for service provider (development).
Next week we will slow down the flow of new material. We will start with a summary of what we have done so far and we will start organizing ourselves for the test.
There will be one guest lecture during the week of October 19-23, on web security.
Special guest lecturer:
Scott Hutton, Lead Security Engineer and Co-Acting Security Office, UITS
There will be another guest lecture on Internet2 probably in November, I just received an initial confirmation from
Brent Sweeney, Senior Network Engineer, UITS.Negotiations are underway to bring someone from Kiva Networking or Bluemarble (ISPs outside the burrow cluster), and someone from the UITS Usability lab (on graphic design and usability on the web).