Finally, please make your documents professional. Part of your grade on the documents will depend on the appearance, organization and attention to clear writing in your documents.
I've made a few modifications since we discussed this document in class the other day.
Requirements Document for the XYZZ project
Your names here together with email addresses.
Include, in your own words, the purpose of a requirements document.
This should be a list of each change to the document together with the date the change was made and the reason for the change (i.e., respond to client's or reviewer's comments). The first entry should be the date on which the document was first turned in to me.
I use \LaTeX for much of my writing, and would be happy to give an hour's lesson in its use. I'm sure that any word processor you use will have some provision for table of contents (though I've never learned how to do it in MS Word, I'm afraid).
All documents turned in as a part of this project should have these initial five sections.
Brief description of the problem this system solves, and how it will solve the problem. For further details on this (and the following sections), please refer to the generic document outline on page 69.
Definitions of technical terms. Remember that you are writing for both a technical and a non-technical audience.
Since we won't start discussing these until Friday, this part will be due at the same time as the functional specifications (below).
Description of services provided.
Imposed constraints, models, standards go here.
Assumptions made in determining how the system will operate and how it will change in the future.
This is the functional specification portion of the document, and
will be provided later.