8 Software Documentation Free Online FlashCards

What does software documentation explain?

Software documentation explains how a system is used, built, operated, and changed.

What is the main purpose of a software tutorial?

A tutorial helps readers learn by following a working example.

What does a how-to guide help a reader do?

A how-to guide explains how to accomplish a specific task, such as configuring a database connection.

What information belongs in reference documentation?

Reference documentation states precise facts, such as configuration options, commands, types, and interface behavior.

What topics do operational guides cover?

Operational guides cover deployment, monitoring, recovery, and troubleshooting.

What should determine the form of technical documentation?

Choose the documentation form based on the reader’s goal; mixing purposes can make information harder to find.

What is the purpose of an architecture decision record?

An ADR captures one significant design decision and its reasoning, creating a history of choices and trade-offs.

What are the common sections of a lightweight ADR?

A common lightweight ADR includes a title, status, context, decision, and consequences.

How should a changed architectural decision be recorded?

If a decision changes, preserve the earlier ADR and create a new record explaining what superseded it.

Do ADRs replace current system documentation?

ADRs preserve the reasoning at the time of a decision; they do not replace current system documentation.

What role does API documentation serve?

API documentation is the contract between an API provider and its users; it clarifies how to call operations and what to expect.

What should API documentation explain about errors?

Document possible errors and their meanings, including how a caller can respond.