mikeymicrophone / commissulator

Commissulator is a set of tools that help Real Estate Agents working with Citi Pads in Manhattan streamline their paperwork.
Other
3 stars 4 forks source link

Preliminary application behavior specification writing #25

Open mikeymicrophone opened 5 years ago

mikeymicrophone commented 5 years ago

Commissulator has very little test coverage using Rspec. A step towards increasing coverage is writing sentences about what it is capable of doing.

Some of those can be turned into executable specs/tests, and some can be turned into documentation.

mikeymicrophone commented 5 years ago

My typical convention for describing use cases is to begin with the user class and then describe the use case in the present tense.

An agent can view their deals.

An admin can view an agent's deals.

An agent can add a co-broker to a deal.

mikeymicrophone commented 5 years ago

The goal of this task is to form a reasonably complete (but not ridiculously exhaustive) list of what Commissulator can do. You will have lots of guidance for what the list should include, but will also be free to click around the app and explore the code to find additional capabilities.