Scribd
Upload
34 views

Software Documentation Project Description - Spring2020

This document outlines the requirements for a group software documentation project. Students will work in groups of 3-5 members to document one of several e-learning platforms. They must choose tasks from the software to document, including 3 simple and 3 complex tasks. The documentation will include task descriptions, tutorials, procedures, and references. It must follow standard guidelines and formatting for software documentation. The final submission is due by Sunday April 30, 2020.

Uploaded by

A'sem Abu alrub
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
34 views

Software Documentation Project Description - Spring2020

This document outlines the requirements for a group software documentation project. Students will work in groups of 3-5 members to document one of several e-learning platforms. They must choose tasks from the software to document, including 3 simple and 3 complex tasks. The documentation will include task descriptions, tutorials, procedures, and references. It must follow standard guidelines and formatting for software documentation. The final submission is due by Sunday April 30, 2020.

Uploaded by

A'sem Abu alrub
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 3

Software Documentation (SE323)

Project Description
Spring 2019/2020

 Group Construction:
 The first step of any project is building a group, students will work in groups of (3-5)
members.

 Project Title:
 The second step is choosing the software. Your project will provide a full
documentation in Distance Learning Domain (Please choose one of the following):
 JUST E-learning
 Microsoft Team
 Zoom
 Google Class Room
 Coursera
 Khan Academy
 The documentation will be provided for (JUST Students in Corona Time)
 The user analysis must be applied on SE students.
 The domain knowledge for these application is Distance Learning.

 Task List and Task Description:


 Third step is choosing the tasks to be documented. Group members must discuss the
software and make analysis of the software tasks and observe the main tasks in the
program and choose eight tasks (three simple, three complex).
 The tasks must be related together, and in the same category.
 First you must write task list that your documentation will contain.
 You must use the template in Chapter One (Task description and Task list).
 Choose the tasks and write it depending on the task orientation guidelines.
 Remember that task description is written for technical writer.

 Tutorial:
 Fourth step is build the tutorial , as we know that there are many types of tutorial ,
you must build :
o Instruction manual.
o Demonstration (Choose one of the complex task and make a demo for it)
 You must apply the tutorial guidelines that we covered in Chapter Two (please read it
carefully).
 You must covered the same task tasks we choose it in third step.

 Procedure:
 Fifth step is build the Procedure , as we know that there are four types of Formats,
you must build Procedure and apply three formats in the appropriate tasks:
 Standard Format.
 Parallel Format.
 Prose Format.
 You must apply the Procedure guidelines that we covered in Chapter Three.
 You must covered the same tasks we choose it in third step.
 All elements of procedure (overview, steps, options, notes, tips, warnings,
elaboration, etc.) must be covered.
 Please, make your own design for procedure.

 Reference:
 Sixth step is build the Reference, as we know that there are many types of Reference,
you must build Appendix.
 You must apply the Reference guidelines that we covered in Chapter Four.
 You must have your own design of the reference type.

 General Guidelines:
 Project members must set up the standard design for each type of the documentation
to maintain the consistency of the whole documentation.
 You must apply all the task orientation guidelines.
 You must apply a Table of contents for your documentation.
 Please apply the English language standards in writing your documentation.
 The grading for your project would be based on number of criteria:
 Organization.
 Content Quality.
 Layout.
 Formatting.
 Visual Design.
 Production and print quality.
 Appropriate use of language.
 Appropriate visual cues (italic, bold, coloring, spacing and arrangement).
 Table of Contents.

 Final project:
 You must provide all documentation on E-Learning in compressed format, and a text
file contain the following info:
 Project title.
 Project Member names and ID.
 The folder must contain:
 Task Description of (word format).
 Tutorials( source format, and deliverable format. Ex: .doc and .pdf).
 Procedure.
 Reference.

 Note :
 Four main phases must be provided, any type not provided, team will get ZERO in all
project.
 Any creative idea on the work is BONUS.
 Don’t copy material from any website. Write your own text and make your own
design.
 Grade: 20 points

 Due Date:
 Sunday 30 April 2020 23:55 P.M.

Lect. Fatima Mohammed AbuHjeela.

You might also like