Skip to content

Latest commit

 

History

History

docs

<Please keep the folder structure as given in the template repo. We will discuss each artifact as we get to it in the course. In some cases, like for the SRS, you should have a file of the same name. For other cases, like the design documentation, you are required to document your design, but it may not be via a module guide and module interface specification documents.>

<You should select an SRS template. Three options are available in the repo, or you can introduce another template. You should delete any SRS options that you do not need. The folder SRS holds a template for Scientific Computing software; the folder SRS-Volere holds the Volere template in LaTeX; the folder SRS-Meyer holds the template that Dr. Mosser now uses in the third year requirements course.>

<The Makefile assumes the SRS will be in a folder called SRS. If you use the Makefile with a template other than the Scientific Computing template, you will have to delete the unnecessary folders and rename your folder to SRS.>

Documentation folders

The folders and files for this folder are as follows:

Describe ...