Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#564 lg 03 07 interface characteristics #639

Closed
wants to merge 3 commits into from

Conversation

gernotstarke
Copy link
Member

looking for feedback

@gernotstarke gernotstarke added learning content the learning content needs polishing, rework or otherwise needs attention enhancement V2025 Release 2025 labels Oct 13, 2024
@gernotstarke gernotstarke self-assigned this Oct 13, 2024
Copy link
Contributor

github-actions bot commented Oct 13, 2024

Build Successful! You can find a link to the downloadable artifacts below.

Name Link
Commit ab81b56
Logs https://github.com/isaqb-org/curriculum-foundation/actions/runs/11373096152
Download https://github.com/isaqb-org/curriculum-foundation/suites/29714142522/artifacts/2065568862

Copy link
Contributor

@rhoadesre rhoadesre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please separate the two changes.
I am fine with the resolution of the original issue (interface characteristics), but the documentation of quality requirements is a completely different issue.
And I, like Daniel, definitely do not agree that a decision was made regarding this latter issue.

docs/03-design/LG-03-07.adoc Outdated Show resolved Hide resolved
Copy link
Contributor

@alxlo alxlo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mit der "hohen Bedeutung" hätte ich noch etwas Formulierungsbauchschmerzen. Ansonsten finde ich die Änderungen ganz gut. Die Systematiserung der Charakteristika ist sicher nicht vollendet, aber gut genug.

docs/03-design/LG-03-07.adoc Outdated Show resolved Hide resolved
docs/03-design/LG-03-07.adoc Show resolved Hide resolved
docs/03-design/LG-03-07.adoc Outdated Show resolved Hide resolved
docs/03-design/LG-03-07.adoc Outdated Show resolved Hide resolved
@gernotstarke
Copy link
Member Author

I took the liberty of slightly updated the wording again:

1.) the introductory paragraph.

DE:

Softwarearchitekt:innen kennen die kritische Bedeutung von Schnittstellen für die Interaktion zwischen Architekturbausteinen und zwischen dem System und externen Elementen.
Sie können solche Schnittstellen entwerfen und spezifizieren.

EN:

Software architects know the critical importance of interfaces for the interaction between architectural building blocks or between the system and external elements.
They can design and specify such interfaces.

2. First section

we had "know desired characteristics" .... and then "and use these in their design".
That was plain wrong - as we cannot USE a characteristic, but need to ACHIEVE them.

new version:

DE:

Sie kennen ... wünschenswerte Eigenschaften von Schnittstellen und können diese beim Entwurf erreichen (R1)

EN:

They know ... desired characteristics of interfaces and can achieve them in the design (R1)

In addition, I changed "festlegen" to "spezifizieren" in the DE version.

@alxlo alxlo self-requested a review October 16, 2024 21:05
alxlo
alxlo previously approved these changes Oct 16, 2024
@gernotstarke gernotstarke dismissed alxlo’s stale review October 16, 2024 21:07

The merge-base changed after approval.

@rhoadesre rhoadesre self-requested a review October 17, 2024 11:58
rhoadesre
rhoadesre previously approved these changes Oct 17, 2024
@gernotstarke gernotstarke dismissed rhoadesre’s stale review October 17, 2024 11:59

The merge-base changed after approval.

@rhoadesre
Copy link
Contributor

I'm fine with these changes, but the changes are blocked.
@uli: is this because of your change request or mine?

@ulibecker ulibecker dismissed their stale review October 17, 2024 12:42

outdated

sippsack
sippsack previously approved these changes Oct 17, 2024
Copy link
Contributor

@sippsack sippsack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I like the ADR. 👍 (eat your own dog food)

@gernotstarke gernotstarke dismissed sippsack’s stale review October 17, 2024 19:57

The merge-base changed after approval.

@kraemerdr
Copy link

@sippsack The ADR has accidentally been introduced in this issue and belongs to #597 instead. ;-)
What exactly do you mean with 'eat your own dog food' in this case?

@gernotstarke
Copy link
Member Author

It should better be called "drink your own champagne", a little less disgusting ...

I guess @sippsack referred to the ongoing recital of "use ADRs to document architectural decisions" - and we used an ADR ourselves to document OUR decision...

@gernotstarke
Copy link
Member Author

shall I open a NEW PR with ONLY the interface-related change in it?
So it becomes better comparable to the existing version?

@sippsack
Copy link
Contributor

@kraemerdr https://en.wikipedia.org/wiki/Eating_your_own_dog_food

I thought the ADR belongs to this PR. I didn't recognize that it belongs somewhere else.

@kraemerdr
Copy link

@sippsack I know the phrase, of course, but was wondering what the 'dog food' actually is here. If you meant ADRs in general, that makes perfect sense. ;-)

@gernotstarke gernotstarke added the wontfix This will not be worked on label Oct 22, 2024
@gernotstarke
Copy link
Member Author

I close this one, as the many changes are too difficult to track. I have opened a new PR #659 on a fresh branch

@gernotstarke gernotstarke deleted the #564-LG-03-07-interface-characteristics branch October 22, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement learning content the learning content needs polishing, rework or otherwise needs attention V2025 Release 2025 wontfix This will not be worked on
Projects
Status: Done / Implemented
Development

Successfully merging this pull request may close these issues.

6 participants