Prepare formal documentation of the code for the process


Prepare formal documentation of the code for the process management simulation labs for Weeks 1 thru 3. You need an install and README file, a user guide, a system programming guide, and manual pages.

Here is what I expect for lab7:

1. An Install and README file: A single file that gives a brief description of the program, how to install it, how to execute it (you don't really need to explain commands etc, just how to start the program), and maybe references to any other relevant information (i.e. for more information consult the user guide). The overall guidance here is: keep it short and to the point.

2. A User Guide: You need to describe the program's behavior (what the user should expect to see), what the commands are and their purposes. You probably want to describe the format of the "program" files that the simulator runs. Almost all the information you need is on the iLab page itself, except you should describe any thing about your program that may be special, different, or not immediately obvious to a user. The overall guidance here is to accurately describe how to use all aspects of the program without talking about how the program works or is implemented (unless it is absolutely essential to understand how to use the program).

3. A System Programming Guide: This guide will explain the design and structure of the program itself. Describe how it works on an internal level. This is a guide a programmer might use, so you want to consider the use cases that relate to a programmer. What if a programmer wanted to add a new command? How about a new program operation? etc.. The information contained within should give a programmer a good idea of which parts of the program provide specific functionality, and how that functionality is implemented. You don't want to go down to the level of describing the code itself in words, but you do want to describe any important algorithms in detail, and at least generalize how things work. The overall guidance here is to leave out details about how to run or use the program, and just talk about how the program actually does its job.

4. Manual pages: This is mostly going to be a reformatting of the Users Guide. You should follow the format of a typical Unix/Linux man page (google around to find some examples). I would include most or all of the things in the Users Guide.

Attachment:- Lab_Instruction.rar

Solution Preview :

Prepared by a verified Expert
Simulation in MATLAB: Prepare formal documentation of the code for the process
Reference No:- TGS01378669

Now Priced at $50 (50% Discount)

Recommended (97%)

Rated (4.9/5)