CIS 3512 Software Documentation – Spring 2014 – Online
Rex Cason
Office Hours: Office Hours: Please email me at rcason@uwf.edu or post
in the discussion board if you have any questions
TEXT: none – materials to be provided online
Week
4
6
7
File Name
Investigating Requirements 1
Investigating Requirements 2
Process Modeling 1
Process Modeling 2
Requirements Documents 1
Requirements Documents 2
Source
“Systems Analysis and Design in a Changing World, 3rd
Edition.”
Modern Systems Analysis and Design. I believe it is the 5th
edition version (ISBN: 0132240769)
Software Requirements, 2nd Edition by Karl E. Wiegers
(ISBN: 0-7356-1879-8)
COURSE OBJECTIVES: The goal of this course is to research and discuss the importance of
documentation in the software development process. A variety of textual, graphical, and coderelated techniques will be covered.
STUDENT LEARNING OUTCOMES:
After completing the course, students will be able to
1. Describe the nature of software documentation
2. Identify the key elements of documentation design
3. Develop criteria to test and analyze the effectiveness of software documentation
4. Apply principles of software engineering to software documentation design and
development
5. Conduct a software documentation project and prepare a project report
TOPICS COVERED:
1. What is software documentation?
3. Understanding users and their need for software documentation
4. Understanding and designing for collaboration and communication
5. Understanding how software documentation affects users and systems personnel
6. The process of software documentation design
7. Identifying needs and establishing requirements for software documentation
GRADING:
Assignments 1-9 @ 7.1%
64%
Exam
Project Report
21%
15%
Grading Scale:
100 - 93 A
<93 - 90 A<90 - 87 B+
<87 - 83 B
<83 - 80 B<80 - 77 C+
<77 - 73 C
<73 - 70 C<70 - 67 D+
<67 - 60 D
<60
F
NOTE: Students are expected to complete work and take exams on schedule. The grade of
"incomplete" is not normally allowed, and is reserved for a most unusual emergency---and
only then if at least 70% of the course has been completed.
CLASS SCHEDULE AND TOPICS COVERED
More detailed directions are found in the content section under “What to do in week __”
Week 1: Introduction
Week 2: Researching CS sources and articles
Week 3: CS Article Review and summary (500 word minimum)
Week 4: Investigating Requirements and a paper on Joint Application Design (750 word minimum)
Week 5: Process Narrative and Diagram
Week 6: Process Modeling and Dataflow Diagram
Week 7: Requirements Documentation and Report Sources (APA format)
Week 8: Work on First Draft of report
Week 9: First Draft due (1000 word minimum)
Week 10: Spring Break
Week 11: Work on Second Draft
Week 12: Second Draft due (2000 word minimum)
Week 13: Work on Final Draft
Week 14: Final Report due (3500 word minimum) and begin Final Exam
Week 15: Final Exam due
PLAGARISM - CHEATING
Students are expected to do their own work. Under no circumstances will cheating on
examinations be tolerated. Such behavior could result in failure of the course and
suspension.
The Student Code of Conduct sets forth the rules, regulations and expected behavior of
students enrolled at the University of West Florida. Violations of any rules, regulations, or
behavioral expectations may result in a charge of violating the Student Code of Conduct. It
is the student’s responsibility to read the Student Code of Conduct and conduct themselves
accordingly. You may access the current Student Code of Conduct at
http://www.uwf.edu/judicialaffairs.
Questions?
E-mail Mr. Rex Cason: rcason@uwf.edu