It can be useful for devs to see your cases such as:
Given: some slightly odd state
When: I send the API something a bit edge case
Then: do this particular thing.
Now that makes sense.
I certainly do want to document common use-cases.
Events are a fine example of something that can have non-intuitive handling of state. The is business logic about events, how they move from 'proposed' to 'confirmed' and eventually are either 'postponed' or 'cancelled' or they become past events that have happened.
When I'm done with the basic documentation and a basic and complete API, then I'll move to advanced functionality and documentation.
Right now I'm spending more time documenting than coding, and that's a worry as we're probably a little bit behind where we want to be.
Now that makes sense.
I certainly do want to document common use-cases.
Events are a fine example of something that can have non-intuitive handling of state. The is business logic about events, how they move from 'proposed' to 'confirmed' and eventually are either 'postponed' or 'cancelled' or they become past events that have happened.
When I'm done with the basic documentation and a basic and complete API, then I'll move to advanced functionality and documentation.
Right now I'm spending more time documenting than coding, and that's a worry as we're probably a little bit behind where we want to be.