Re: Feedback request: class Connection documentation

Hi Bo,

Thank a lot for your feedback!

R stands for Rationale. I don’t want to use Requirement because requirements describe what the software as a whole should do. When we are at the class level we actually solve small problems the solutions of which help us fulfill the requirements. As I have done it now, the rationales describe both the problem and give an example for an occurrence of the problem. I thought about separating them at first but didn’t like the result in the first try but maybe you can do better then me. Please give it a try!

What you suggest could probably be mapped to:

1. What is the problem? -> Problem description (P)

2. Why do we have it? -> Why or where? Do you want to explain the cause for the problem? I think it is good to give some examples anyway. -> Example for the problem occurrence (E), or you can suggest something else?

3. How do we solve it? -> Problem solution (S)

Best regards,

Peter

Would you like to post a relpy?


This post is a reply to:
Re: Feedback request: class Connection documentation
Hi Peter and everyone, Here are my answers to your request for feedback:) 1. Is the information provided in the documentation enough to understand BOTH the problem and the solution? Yes 2. Do (more...)

No follow-ups yet.