Documentation

#Meetings

• Minutes of meetings should be in plain text, and should be emailed to all project members within 24 hours of the meeting.

• a project title, which should include the name of the project (e.g., Group Project 07);
• the meeting purpose (e.g., Weekly Project Meeting);
• a list of the people present at the meeting plus any apologies;
• the place and date of the meeting;
• a circulation list, which should include all those present plus other persons as appropriate; for weekly project meetings, all project members plus the Project Manager should receive the minutes. • the author of the minutes;
• the date the minutes were produced; the version number of the minutes, increased if they have to be recirculated because of errors. Following the above information should be the following headings and descriptions:
• Matters arising - this section will describe matters arising from previous meetings, in particular describing the progress of actions propagated from the previous meeting; each significant point will be numbered so that it can be referenced when being discussed;
• New business - this section will describe each significant new piece of business, numbering each item;
• AOB - this section will describe items discussed as any other business (AOB), and each significant point will be numbered.

• For all sections of the minutes, actions decided upon must be indicated, and on a new line must be the word ACTION: and the email address of people designated to carry out the action.

Formal Project Documents

• All formal project documents (i.e., those identified in the Project Management standards, with the exception of the User Interface Presentation) [4] must contain the following information on the front cover:

• a title, which should clearly indicate both the project and nature of the particular document (e.g., Group Project 07 - Design Specification);
• the author(s) of the document;
• the configuration reference for the document (see QA document SE.QA.08 [3] for details of configuration references);
• the date the latest version of the document was produced;
• the version number of the document. This should be incremented if a new release of the document is made.
• the document status (see QA document SE.QA.08 [3] for details of permitted document statuses); • the name and address of the Department, together with a copyright notice. Each page within the document must contain the following information:
• a page header containing: o the title of the document (abbreviated if the full title is too long); o the version number of the document; o the status of the document, in brackets (e.g. Draft or Released); Software Engineering Group Projects – General Document Standards / 2.1 (Release) Aberystwyth University / Computer Science Page 5 of 8
• a page footer containing: o the phrase Aberystwyth University / Computer Science; o a page number in the form: Page x of y where x is the page number and y is the total number of pages; page 1 will be the front cover. Note that for a document which is not yet under change control, there should be a version number (start at v0.1) and date, and the status should be draft. CONTENTS, INTRODUCTION, SPECIFIC SECTIONS GO HERE, REFERENCES, DOCUMENT CHANGE HISTORY

• All documents must be produced using a word processor or document preparation system.