10+ do's and dont's for writing better use cases

18
<<include>> <<include>> <<extend>> Inform cop Register vehicle Send message Maintain registry Cop Road & Transport Officer Administrator Owner 10++ do’s and don’t for writing better use cases By Andreas Hägglund

Upload: andreas-haegglund

Post on 10-Dec-2014

292 views

Category:

Business


2 download

DESCRIPTION

10+ do's and dont's for greatly improving your use case specifications.

TRANSCRIPT

Page 1: 10+ do's and dont's for writing better use cases

<<include>> <<include>>

<<extend>>

Inform cop

Register vehicle

Send message

Maintain registry

Cop

Road & Transport

Officer

Administrator

Owner

10++ do’s and don’t for writing better use cases

By Andreas Hägglund

Page 2: 10+ do's and dont's for writing better use cases

1. Use Active Tense

DO!

”The system calculates the interest rate and returns it”

”The interest rate is calculated and returned by the system”

DON’T!

Page 3: 10+ do's and dont's for writing better use cases

2. Start every step with Actor/System

DO!

1. ”The system does this” 2. ”The Actor does this” 3. ”The system does this” 4. ”The Actor does this”

1. ”This gets done” 2. ”Then this gets done” 3. ”And finally this happens”

DON’T!

Page 4: 10+ do's and dont's for writing better use cases

3. Be specific

DO!

1. ”The user registers customer data (name, adress, social security number, email adress, home adress)”

1. ”The user registers customer data”

DON’T!

Page 5: 10+ do's and dont's for writing better use cases

4. Tell how the use case is initiated

DO!

”The use case starts when the [Customer] selects to withdraw money” 1. ”The Actor does this” 2. ”The system does this” 3. ”The Actor does this”

1. ”The Actor does this” 2. ”The system does this” 3. ”The Actor does this”

DON’T!

Page 6: 10+ do's and dont's for writing better use cases

5 Write it as a dialogue

DO!

1. ”The Actor registers X” 2. ”The system does this and outputs Y” 3. ”The Actor does Z”

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum ac molestie est, eget aliquam tellus. Maecenas a auctor lorem, in luctus risus. Etiam molestie at erat vel feugiat.

DON’T!

Page 7: 10+ do's and dont's for writing better use cases

6 Include an activity diagram

DO! Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum ac molestie est, eget aliquam tellus. Maecenas a auctor lorem, in luctus risus. Etiam molestie at erat vel feugiat.

DON’T!

”The Actor does this”

”The System does this”

”The System does this”

X=12

X<>12

Page 8: 10+ do's and dont's for writing better use cases

7. Use tabstops to indicate loops and alternatives

DO!

1. ” For every X” 1. The Actor registers X” 2. ”The system does this and outputs Y” 3. ”The Actor does Z”

2. ”The System” then ...”

1. ” For every X” 1.1 ”The Actor registers X” 1.2 ”The system does this and outputs Y” 1.3 ”The Actor does Z” 2. ”The System” then ...”

DON’T!

Page 9: 10+ do's and dont's for writing better use cases

8 Use numbers and letters with a meaning

DO WHEN ORDER IS IMPORTANT!

1. The Actor registers X” 2. ”The system does this and outputs Y” 3. ”The Actor does Z” 4. ”The System”

1a. ”The Actor registers X” 1b. ”The system does this and outputs Y” 1c. ”The Actor does Z” 2. ”The System”

DO WHEN ORDER IS NOT IMPORTANT

Page 10: 10+ do's and dont's for writing better use cases

9 Don’t make the steps too loooong

DO!

1. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum ac molestie est, eget aliquam tellus. Maecenas a auctor lorem, in luctus risus. Etiam molestie at erat vel feugiat. Suspendisse nibh metus, sollicitudin quis pretium vitae, convallis nec justo.

2. Nunc tristique, risus eget blandit tincidunt, turpis justo pharetra est, nec malesuada justo quam eget nibh. Sed nec aliquet nisi. Nulla facilisi. 3. Nulla facilisi. Ut id venenatis enim. Nulla non nunc ante. Donec eu dui purus. Donec accumsan tortor auctor, viverra mauris vitae, feugiat lectus. 4. Fusce semper nibh in eros egestas, nec interdum diam aliquet. Integer nec maximus massa. Integer vel arcu euismod, faucibus ligula ultricies, faucibus velit. Fusce eleifend

blandit libero ut bibendum. Quisque facilisis tortor ac nisi rhoncus condimentum. Proin vulputate hendrerit ipsum, sit amet interdum libero cursus eget. 5. Quisque ultricies at neque cursus vulputate. Suspendisse vehicula quis risus nec tristique. Integer quis magna semper, convallis lectus quis, ultrices leo. Nam a orci id diam

pulvinar consectetur sed non est. Nullam imperdiet dui nec lorem dapibus, ac ultricies risus elementum. 6. Morbi suscipit lorem nec volutpat cursus. In ut dignissim augue, at dapibus enim. Nunc enim diam, faucibus a arcu in, accumsan rhoncus nibh. Ut et congue lectus. Praesent

euismod lacus tortor, sit amet tempor odio facilisis id. 7. Interdum et malesuada fames ac ante ipsum primis in faucibus. Aliquam neque nulla, pharetra non mattis sit amet, pharetra sed sapien. Pellentesque tristique dui facilisis augue

finibus, nec tristique sem interdum. Nullam tincidunt metus eget libero iaculis consectetur. Integer congue erat a ipsum laoreet, aliquet bibendum nunc suscipit. 8. Nunc sagittis mauris eu magna lobortis, non malesuada augue luctus. Interdum et malesuada fames ac ante ipsum primis in faucibus. Suspendisse id auctor est. Pellentesque ut

tellus scelerisque nisl auctor cursus. Ut eu lorem pretium, rutrum erat et, egestas augue. Nulla eget neque orci. 9. Nullam sollicitudin commodo neque, a varius metus condimentum id. Cras nec diam consectetur, tincidunt mi eget, luctus lacus. Aliquam ante mi, convallis vel orci et, bibendum

porttitor nisi. Pellentesque luctus rhoncus risus eu luctus. Aenean justo augue, lobortis eu egestas sit amet, vehicula quis turpis. Ut vel mollis quam. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.

10. Morbi tincidunt luctus leo sed lacinia. Vestibulum ante justo, luctus ut eros nec, faucibus viverra arcu. Sed ut tellus tincidunt lorem posuere accumsan. Mauris elementum non arcu non euismod. Nam vulputate erat quis pulvinar posuere. Pellentesque nec eleifend lorem. Ut blandit hendrerit bibendum.

11. Proin sed varius nibh. Duis aliquet, tortor eget ultricies pharetra, dui dui accumsan magna, eget elementum tortor nunc eu nulla. Praesent rhoncus turpis a nunc luctus, in vestibulum ligula semper. Praesent sit amet orci odio. Nulla ornare enim nisi, ac pellentesque erat consectetur nec. Duis tincidunt tortor sit amet sagittis vehicula.

12. Suspendisse feugiat velit neque, quis pellentesque felis viverra ac. In porta, lorem ac aliquet consectetur, risus ante elementum massa, eu egestas turpis enim non enim. Nullam neque turpis, dictum quis turpis nec, euismod rhoncus ligula. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Proin aliquet dapibus mauris, a vehicula tortor scelerisque sed.

1. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum ac molestie est, eget aliquam tellus. Maecenas a auctor lorem, in luctus risus. Etiam molestie at erat vel

feugiat. Suspendisse nibh metus, sollicitudin quis pretium vitae, convallis nec justo. Nunc tristique, risus eget blandit tincidunt, turpis justo pharetra est, nec malesuada justo quam eget nibh. Sed nec aliquet nisi. Nulla facilisi. Nulla facilisi. Ut id venenatis enim. Nulla non nunc ante. Donec eu dui purus. Donec accumsan tortor auctor, viverra mauris vitae, feugiat lectus. Fusce semper nibh in eros egestas, nec interdum diam aliquet. Integer nec maximus massa. Integer vel arcu euismod, faucibus ligula ultricies, faucibus velit. Fusce eleifend blandit libero ut bibendum. Quisque facilisis tortor ac nisi rhoncus condimentum. Proin vulputate hendrerit ipsum, sit amet interdum libero cursus eget. Quisque ultricies at neque cursus vulputate. Suspendisse vehicula quis risus nec tristique. Integer quis magna semper, convallis lectus quis, ultrices leo. Nam a orci id diam pulvinar consectetur sed non est. Nullam imperdiet dui nec lorem dapibus, ac ultricies risus elementum. Morbi suscipit lorem nec volutpat cursus. In ut dignissim augue, at dapibus enim. Nunc enim diam, faucibus a arcu in, accumsan rhoncus nibh. Ut et congue lectus. Praesent euismod lacus tortor, sit amet tempor odio facilisis id. Interdum et malesuada fames ac ante ipsum primis in faucibus. Aliquam neque nulla, pharetra non mattis sit amet, pharetra sed sapien. Pellentesque tristique dui facilisis augue finibus, nec tristique sem interdum. Nullam tincidunt metus eget libero iaculis consectetur. Integer congue erat a ipsum laoreet, aliquet bibendum nunc suscipit. Nunc sagittis mauris eu magna lobortis, non malesuada augue luctus. Interdum et malesuada fames ac ante ipsum primis in faucibus. Suspendisse id auctor est. Pellentesque ut tellus scelerisque nisl auctor cursus. Ut eu lorem pretium, rutrum erat et, egestas augue. Nulla eget neque orci.

2. Nullam sollicitudin commodo neque, a varius metus condimentum id. Cras nec diam consectetur, tincidunt mi eget, luctus lacus. Aliquam ante mi, convallis vel orci et, bibendum

porttitor nisi. Pellentesque luctus rhoncus risus eu luctus. Aenean justo augue, lobortis eu egestas sit amet, vehicula quis turpis. Ut vel mollis quam. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Morbi tincidunt luctus leo sed lacinia. Vestibulum ante justo, luctus ut eros nec, faucibus viverra arcu. Sed ut tellus tincidunt lorem posuere accumsan. Mauris elementum non arcu non euismod. Nam vulputate erat quis pulvinar posuere. Pellentesque nec eleifend lorem. Ut blandit hendrerit bibendum. Proin sed varius nibh. Duis aliquet, tortor eget ultricies pharetra, dui dui accumsan magna, eget elementum tortor nunc eu nulla. Praesent rhoncus turpis a nunc luctus, in vestibulum ligula semper. Praesent sit amet orci odio. Nulla ornare enim nisi, ac pellentesque erat consectetur nec. Duis tincidunt tortor sit amet sagittis vehicula. Suspendisse feugiat velit neque, quis pellentesque felis viverra ac. In porta, lorem ac aliquet consectetur, risus ante elementum massa, eu egestas turpis enim non enim. Nullam neque turpis, dictum quis turpis nec, euismod rhoncus ligula. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Proin aliquet dapibus mauris, a vehicula tortor scelerisque sed.

DON’T!

Page 11: 10+ do's and dont's for writing better use cases

1. Lorem ipsum dolor sit amet, consectetur adipiscing elit. 2. Vestibulum ac molestie est, eget aliquam tellus. 3. Maecenas a auctor lorem, in luctus risus. 4. Etiam molestie at erat vel feugiat. 5. Suspendisse nibh metus, sollicitudin quis pretium vitae, convallis nec justo. 6. Nunc tristique, risus eget blandit tincidunt, turpis justo pharetra est, nec

malesuada justo quam eget nibh. 7. Sed nec aliquet nisi. 8. Nulla facilisi. 9. Nulla facilisi. 10. Ut id venenatis enim. 11. Nulla non nunc ante. 12. Donec eu dui purus. 13. Donec accumsan tortor auctor, viverra mauris vitae, feugiat lectus. 14. Fusce semper nibh in eros egestas, nec interdum diam aliquet. 15. Integer nec maximus massa. 16. Integer vel arcu euismod, faucibus ligula ultricies, faucibus velit. 17. Fusce eleifend blandit libero ut bibendum. 18. Quisque facilisis tortor ac nisi rhoncus condimentum. 19. Proin vulputate hendrerit ipsum, sit amet interdum libero cursus eget. 20. Quisque ultricies at neque cursus vulputate. 21. Suspendisse vehicula quis risus nec tristique. 22. Integer quis magna semper, convallis lectus quis, ultrices leo. 23. Nam a orci id diam pulvinar consectetur sed non est. 24. Nullam imperdiet dui nec lorem dapibus, ac ultricies risus elementum. 25. Morbi suscipit lorem nec volutpat cursus. 26. In ut dignissim augue, at dapibus enim. 27. Nunc enim diam, faucibus a arcu in, accumsan rhoncus nibh. 28. Ut et congue lectus. Praesent euismod lacus tortor, sit amet tempor odio

facilisis id. 29. Interdum et malesuada fames ac ante ipsum primis in faucibus. 30. Aliquam neque nulla, pharetra non mattis sit amet, pharetra sed sapien. 31. Pellentesque tristique dui facilisis augue finibus, nec tristique sem

interdum. 32. Nullam tincidunt metus eget libero iaculis consectetur. 33. Integer congue erat a ipsum laoreet, aliquet bibendum nunc suscipit. 34. Nunc sagittis mauris eu magna lobortis, non malesuada augue luctus. 35. Interdum et malesuada fames ac ante ipsum primis in faucibus. 36. Suspendisse id auctor est. 37. Pellentesque ut tellus scelerisque nisl auctor cursus. 38. Ut eu lorem pretium, rutrum erat et, egestas augue. 39. Nulla eget neque orci. 40. Nullam sollicitudin commodo neque, a varius metus condimentum id. 41. Cras nec diam consectetur, tincidunt mi eget, luctus lacus. 42. Aliquam ante mi, convallis vel orci et, bibendum porttitor nisi. 43. Pellentesque luctus rhoncus risus eu luctus. 44. Lorem ipsum dolor sit amet, consectetur adipiscing elit. 45. Vestibulum ac molestie est, eget aliquam tellus. 46. Maecenas a auctor lorem, in luctus risus. 47. Etiam molestie at erat vel feugiat. 48. Suspendisse nibh metus, sollicitudin quis pretium vitae, convallis nec justo. 49. Nunc tristique, risus eget blandit tincidunt, turpis justo pharetra est, nec

malesuada justo quam eget nibh. 50. Sed nec aliquet nisi. 51. Nulla facilisi. 52. Ut id venenatis enim. 53. Nulla non nunc ante. 54. Donec eu dui purus. 55. Donec accumsan tortor auctor, viverra mauris vitae, feugiat lectus. 56. Fusce semper nibh in eros egestas, nec interdum diam aliquet. 57. Integer nec maximus massa. 58. Integer vel arcu euismod, faucibus ligula ultricies, faucibus velit. 59. Fusce eleifend blandit libero ut bibendum. 60. Quisque facilisis tortor ac nisi rhoncus condimentum. 61. Proin vulputate hendrerit ipsum, sit amet interdum libero cursus eget. 62. Quisque ultricies at neque cursus vulputate. 63. Suspendisse vehicula quis risus nec tristique.

10. Don’t make the steps too short

DO!

1. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum ac molestie est, eget aliquam tellus. Maecenas a auctor lorem, in luctus risus. Etiam molestie at erat vel feugiat. Suspendisse nibh metus, sollicitudin quis pretium vitae, convallis nec justo.

2. Nunc tristique, risus eget blandit tincidunt, turpis justo pharetra est, nec malesuada justo quam eget nibh. Sed nec aliquet nisi. Nulla facilisi.

3. Nulla facilisi. Ut id venenatis enim. Nulla non nunc ante. Donec eu dui purus. Donec accumsan tortor auctor, viverra mauris vitae, feugiat lectus.

4. Fusce semper nibh in eros egestas, nec interdum diam aliquet. Integer nec maximus massa. Integer vel arcu euismod, faucibus ligula ultricies, faucibus velit. Fusce eleifend blandit libero ut bibendum. Quisque facilisis tortor ac nisi rhoncus condimentum. Proin vulputate hendrerit ipsum, sit amet interdum libero cursus eget.

5. Quisque ultricies at neque cursus vulputate. Suspendisse vehicula quis risus nec tristique. Integer quis magna semper, convallis lectus quis, ultrices leo. Nam a orci id diam pulvinar consectetur sed non est. Nullam imperdiet dui nec lorem dapibus, ac ultricies risus elementum.

6. Morbi suscipit lorem nec volutpat cursus. In ut dignissim augue, at dapibus enim. Nunc enim diam, faucibus a arcu in, accumsan rhoncus nibh. Ut et congue lectus. Praesent euismod lacus tortor, sit amet tempor odio facilisis id.

7. Interdum et malesuada fames ac ante ipsum primis in faucibus. Aliquam neque nulla, pharetra non mattis sit amet, pharetra sed sapien. Pellentesque tristique dui facilisis augue finibus, nec tristique sem interdum. Nullam tincidunt metus eget libero iaculis consectetur. Integer congue erat a ipsum laoreet, aliquet bibendum nunc suscipit.

8. Nunc sagittis mauris eu magna lobortis, non malesuada augue luctus. Interdum et malesuada fames ac ante ipsum primis in faucibus. Suspendisse id auctor est. Pellentesque ut tellus scelerisque nisl auctor cursus. Ut eu lorem pretium, rutrum erat et, egestas augue. Nulla eget neque orci.

9. Nullam sollicitudin commodo neque, a varius metus condimentum id. Cras nec diam consectetur, tincidunt mi eget, luctus lacus. Aliquam ante mi, convallis vel orci et, bibendum porttitor nisi. Pellentesque luctus rhoncus risus eu luctus. Aenean justo augue, lobortis eu egestas sit amet, vehicula quis turpis. Ut vel mollis quam. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.

10. Morbi tincidunt luctus leo sed lacinia. Vestibulum ante justo, luctus ut eros nec, faucibus viverra arcu. Sed ut tellus tincidunt lorem posuere accumsan. Mauris elementum non arcu non euismod. Nam vulputate erat quis pulvinar posuere. Pellentesque nec eleifend lorem. Ut blandit hendrerit bibendum.

11. Proin sed varius nibh. Duis aliquet, tortor eget ultricies pharetra, dui dui accumsan magna, eget elementum tortor nunc eu nulla. Praesent rhoncus turpis a nunc luctus, in vestibulum ligula semper. Praesent sit amet orci odio. Nulla ornare enim nisi, ac pellentesque erat consectetur nec. Duis tincidunt tortor sit amet sagittis vehicula.

12. Suspendisse feugiat velit neque, quis pellentesque felis viverra ac. In porta, lorem ac aliquet consectetur, risus ante elementum massa, eu egestas turpis enim non enim. Nullam neque turpis, dictum quis turpis nec, euismod rhoncus ligula. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Proin aliquet dapibus mauris, a vehicula tortor scelerisque sed.

DON’T!

Page 12: 10+ do's and dont's for writing better use cases

+ Make sure you spell it right

DO!

Spelling mistakes and bad grammar make a text very hard to read and understand. You might just as well throw them at the cemetery.

Speling misstakes mejks a texts verry herd to riid, end anderstand. Ju mite jast as vell throw they att the cematery.

DON’T!

Page 13: 10+ do's and dont's for writing better use cases

+ Refer to named extionspoints, not step numbers

DO!

5. If X>12 the use case continues at [Discount Applies] 6. The Actor registers X 7. The system does this and outputs Y [Discount Applies] 8. The System calculates discounted amount

5. If X>12 the use case continues at step 8. 6. The Actor registers X 7. The system does this and outputs Y 8. The System calculates discounted amount

DON’T!

Page 14: 10+ do's and dont's for writing better use cases

+ highlight important terms

USE [] WHEN REFERRING TO ACTORS AND/OR EXTENSION POINTS

1. The [Customer] registers customer data 2. If x > 12 the use case continues at [Y] 3. ...

1. The [Customer] registers Customer Data 2. The system generates a new PIN-code 3. ...

USE BOLD OR ITALIC TEXT WHEN TERM IS DEFINED ELSEWHERE

Page 15: 10+ do's and dont's for writing better use cases

+ Rewrite it and compare

It probably gets a little bit better everytime

Page 16: 10+ do's and dont's for writing better use cases

+ Only use include and extend when it improves the use case!

<<include>>

x

<<extend>>

Page 17: 10+ do's and dont's for writing better use cases

+ Don’t take this guide to serious!

Page 18: 10+ do's and dont's for writing better use cases

Want to stay updated?

Ahab1972

/andreashagglund

Systemvaruhuset.net (personal site)

Systemvaruhuset.se (corporate site)