Software Architecture Ebook

Software Architecture Ebook

Software Architecture Ebook

Types Of Documentation

When it comes to technical writing; software documentation is an important one and always in demand. Documentation is an important part of software engineering. Types of documentation include:

  • Requirements -- Statements that identify attributes, capabilities, characteristics, or qualities of a system. This is the foundation for what shall be or has been implemented
  • Architecture/Design -- Includes relations to an environment and construction principles to be used in design of software components
  • Technical -- Documentation of code, algorithms, interfaces, and APIs
  • End User -- Manuals for the end-user, system administrators and support staff
  • Marketing -- How to market the product and analysis of the market demand

A technical writer plays various roles when it comes to writing for the software. In many places, the developers and engineers themselves produce the technical and architecture design documentation.

Below are descriptions of a few documents produced during a software development:

Requirement Specification: This document portrays and describes what the customer has asked for in a form of technical document to actually define what the product will do.


  • Software Architecture Ebook

    Software Architecture Ebook

    Software Architecture Ebook

  • Search