Final Exam Documentation

Edit 0 12 …
Dear Masters,

Here are ideas for the SPID documentation on your own project. You can use your own page to practice and finalize:

Assumptions:
a. Prototype for your project is ready with data and reports as approved by client.
b. Your selected project has to be large-scale, implementable throughout Bangladesh or throughout the world.
c. You must make the nature of your project clear in the PROCESS part.
d. The agreed parts of the documentation are below:

  1. TIME AND BUDGET

  2. USER ACCEPTABILITY TESTING (UAT)

  3. TECHNIQUES

  4. TOOLS

  5. PROCESS

  6. MODIFICATION

  7. REPORT

  8. MANUALS

  9. SLA


For each part of the documentation, you will need at least the following sub-sections or parts. You must describe each part of the documentation with purpose.

  1. TIME AND BUDGET (This part must follow the steps and manpower given in PROCESS)

    • Total time required for each type of person, total cost of each person and what each person will do for implementation step. (3 marks)
    • Qualification and experience needed for each type of person needed to implement and RATE for each person. (3 marks)
    • Specification (configuration) of each type of hardware required, i.e. what will each hardware do with total cost of each. Include power conditioning, backup and recovery arrangements. (2 marks)
    • Specification of each type of software to be implemented, i.e. what outputs and overall work will be done by each type of software once implemented. (2 marks)

  2. USER ACCEPTABILITY TESTING (UAT) (This part will assume that the prototype has real data and all reports, the operation of the reports and correctness of output has been certified by client or concerned management)

    • Sample reports with both INPUT and corresponding OUTPUT data (each report should have a report number) (4 marks)
    • Steps for client or management testing, i.e. how client or management will test the completed software and check whether everything is working and how they will certify that report is ok. (3 marks)
    • Design of form for testing each part of the software and each report. The same form will be used for each part of the software and for each report. (3 marks)

  3. TECHNIQUES (This part will follow the steps given in PROCESS)

    • A complete definition of each of the steps in PROCESS, i.e. how each step will be completed and how client or management will check that the step is completed. Mention what support will be required from the client or management for each step. (4 marks)
    • How the prototype will be converted to real code and installed. What software licenses, URLs, website space, website system software and database software will be required by client. All steps and what each will do. (2 marks)
    • PERT chart or Gantt chart to show the purchase and installation of hardware, licenses, URL, website space, system software, database software and time of checking and certifying each. The Gantt chart will also show installation of each part of the developed software, testing and UAT approval (4 marks).

  4. TOOLS

    • Specification (configuration) of each type of hardware required, i.e. what will each hardware do. Include power conditioning, backup and recovery arrangements. What each will do. (2 marks)
    • Detail steps of how hardware and power conditioning will be installed, how backup arrangements and recovery steps will be arranged. Diagram of these and how each will be tested. (3 marks)
    • Specification of each type of system software to be implemented, i.e. what each type of system software will need to do. (2 marks)
    • Designed form for completion of all tests for hardware, backup, recovery and whether maintenance agreement for each is in place. (3 marks)

  5. PROCESS (Assume that prototype has been approved by management or client)

    • Geographic locations and types (nature) of software to be installed at each location. (2 marks)
    • Mind map of all steps to be taken for implementing completed software till completely operational. (3 marks)
    • Gantt chart of the steps, include time required and type of person who will complete step. (5 marks)

  6. MODIFICATION (A modification may be required when testing the code, if a test fails, after installation, a new feature is required, etc.)

    • Steps of how a modification will be carried out, e.g. modification will first be carried out on the prototype, customer will give approval of modification, which type of change is outside agreement, etc. (4 marks)
    • Design of form called "Request Modification" (3 marks)
    • Description of how modification will be implemented and given a certificate of approval. (3 marks)

  7. REPORT (Report on progress of implementation, problems and support required)

    • Steps of how reporting will be carried out at each stage of implementation according to Gantt chart given in PROCESS. What are the landmarks of success in the project? How will management know that the landmark is successful? Give a list. (4 marks)
    • Form for reporting progress. (3 marks)
    • Form for requesting extension of time due to unforeseen problems in implementation. (3 marks)

  8. MANUALS (Include contents with examples)

    • Technical manual (3 marks)
    • Training and user manual (4 marks)
    • Administrator manual (3 marks)

  9. Service Level Agreement (SLA) (Agreement points with service details)

    • Agreement for hardware maintenance and servicing (3 marks)
    • Agreement for software maintenance and debugging (4 marks)
    • Agreement for software upgrade (3 marks)