Documentation

DOCUMENTATION

Software documentation is written text that accompanies computer software. It either explains how it operates or how to use it, and may mean different things to people in different roles.

Types

Documentation is an important part of software engineering. Types of documentation include :

  • Architecture/Design – Overview of software. Includes relations to an environment and construction principles to be used in design of software
  • Technical – Documentation of code, algorithms, interfaces, and APIs.
  • End User Manuals for the end-user, system administrators and support staff.
  • Marketing – Product briefs and promotional collateral.

Leave a Reply

Your email address will not be published. Required fields are marked *