Module 12: Documentation (Project 3e)

CMPS 262: Advanced Programming

Introduction

We have already seen APIs, which are a kind of technical documentation. There can be additional types of technical documentation that describes code, algorithms, interfaces, etc. Prior to technical documentation, requirements and architecture and design have to be documented as well and we have seen how UML plays a role. When the software is going to be released, an end user manual can be provided to help them. Finally, marketing documents can be created as well.

Module Objectives

  • Describe different types of documentation that exist
  • Write software documentation

Learning Resources

Learning Activities

  • Readings
  • Discussion Board
  • Programming Project

For Further Study

  • Read more about code as documentation by Martin Fowler here

Leave A Reply

Your email address will not be published.