1

In the documentation for the services I develop and maintain, there is a section where the program execution flow is presented as a numbered list, somewhat like a flowchart.

Here's a silly example that documents the process of driving to work in the morning:

  1. Fetch keys from kitchen counter
    1. If no key found, exit with error code 101
  2. Get in the car.
  3. Start the car.
    1. If the car will not start, exit with error code 102
  4. Drive along the route (shown below in image)
  5. If you are hungry for something savory:
    1. ... some steps for going to Taco Bell and buying a breakfast burrito
  6. Otherwise if you are hungry for something sweet:
    1. ... some steps for going to Dunkin Donuts and buying a donut
  7. Otherwise if you are thirsty:
    1. ... some steps for going to Starbucks and buying coffee
  8. Arrive at work and park the car.

Steps 5-7 are obviously an if/else decision tree. This is the best format I've come up with so far, and it works well enough, but I feel like there could be a better way.

Is there a standard way of doing this? Or does anyone have suggestions?

Improve this question
1
  • 1
    This is what you see in surveys: “If the answer is A skip to question X”. Could that apply to the document as well? Commented Sep 25 at 14:04

0

Reset to default

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.