Usage

The usage section allows you to describe how people will use your software system.

Intent

Although your software system may have a separate user guide, there may be times when some lightweight usage instructions are needed.

  • How should different types of users use your software system?
  • Are there any prerequisites?
  • How should other software systems integrate using your API?
  • ...

Structure

A simple narrative or set of instructions is typically sufficient. If this set of usage instructions becomes more than a few pages, consider creating a separate user guide instead.

Motivation

The motivation for including this section is to ensure that you've considered and documented how people will use or integrate with your software system.

Audience

The audience for this section are those people who may use or integrate with your software system.

Required

No, especially if your end-users will not have access to your documentation.