Document Management
CS-160: Software Engineering
Instructor: Robert Bruce
Spring 2017
SLIDE 1: Document management
- Document management is about communication in regards to:
- Revision control / change requests
- Program design specifications
- Individual responsibilities (delegation of tasks)
- Individual contributions (who did what)
- Program comments
- Time management
- Project requirements
- Bug reports
SLIDE 2: Types of documents
- Documentation types include:
- "Requirements"
- "Project emails and memos"
- "Meeting notes"
- "Phone call notes"
- "Use cases"
- "High-level design documents"
- "Low-level design documents"
- "Test plans"
- "Code documentation"
- "Code comments"
- "Extractable code comments"
- "User manuals"
- "Quick start guides"
- "Cheat sheets"
- "User interface maps"
- "Training materials"
- "Meta-training materials"
- "Marketing materials"
- Source: Rod Stephens' Beginning software Engineering, pp. 27-28
SLIDE 3: Document management: Revision Control
- Revision control methods are useful for:
- Checking in or checking-out a given version of a document.
- Edited changes to a document can be folded into a master document.
- Keeping track of revisions/changes to a document.
- Maintaining a master source (document) for editing.
- Revisions can be approved or rejected.
- Examples of revision control software:
- git
- rcs
- cvs
- subversion
SLIDE 4: Document management: web based
- Web-based project management tools:
- Trello at http://www.trello.com
- Slack at http://www.slack.com
- Freedcamp at https://freedcamp.com
- Producteev at https://www.producteev.com/
- Thoughtboxes at https://www.thoughtbox.es/
- Podio at https://podio.com/
- GIT at https://git-scm.com/
Robert Bruce
Research
Courses
Spring 2017, CS-160-03:
Lectures:
- What is software engineering?
- Postgres RDBMS (Relational Database Management System)
- Document management
Assignments:
- Biographical Writeup
- Programming Project 1
- Programming Project 2
- Programming Project 3
- Programming Project 4
- Programming Project 5
- Programming Project 6
- Final Project Oral Presentation
- Final Project Report
Handouts:
- Creating a bootable Linux Mint flash drive
- How to update software on Linux Mint
- How to install and configure the Apache web server on Linux Mint
- How to install and configure the Postgres database server on Linux Mint
- How to build and install Openface on Linux Mint
Programs:
- db_menu
- example_mkdir
- example_fork_exec_pipe
- example_draw_opencv
- example_draw_delaunay_triangles
- example_process_get_form_data
- example_process_post_form_data
Other
