System Documentation

Question 1

What is System Documentation?

Answer 1

It is the set of documents that describes software systems, hardware systems and integrated technical environments. Developer often refer to them.

Question 2

What are the 5 documentation types?

Answer 2

1. Requirements documentation
2. Architecture/Design Documentation
3. Technical Documentation
4. En-User Documentation
5. Process Documentation

Question 3

6 What is the importance of Documentation?

Answer 3

1. Gives knowledge of the systems
2. Reduces on-boarding time
3. Serves as a historic record
4. Supports maintenance and troubleshooting
5. Enables collaboration between stakeholders
6. Reduces dependencies on employees that would leave

Question 4

6 Challenges when creating Documents

Answer 4

1. Balancing comprehensiveness and readability
2. Maintenance accuracy
3. Understanding audience needs
4. Time constraints
5. Technical writing skills
6. Tool selection