Documentation

---

Types

• 3 types of system documentation
  • user documentation
  • system documentation
  • technical documentation

User documentation explains the system to users and may include information such as how to access certain features, frequently asked questions (FAQs), and contact information for customer support.

System documentation describes the system’s internal configuration so the system can be maintained later in its life cycle.

• code is a major part documentation
  • must be versioned and presented in a readable format

Technical documentation describes how to install and maintain the system, including information about installing updates and providing feedback to the development team.