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

change to introductory text on design patterns #298

Closed
wants to merge 1 commit into from

Conversation

MarkoM-dot
Copy link
Contributor

A change to the intro text on Design Patterns. Open to suggestions!

@MarkoM-dot MarkoM-dot marked this pull request as ready for review February 27, 2022 18:02
@MarkoM-dot MarkoM-dot marked this pull request as draft February 27, 2022 18:10
Comment on lines +10 to +17
In software development, we often come across problems that share similarities
regardless of the environment they appear in. Although the implementation details
are crucial to solve the task at hand, we may abstract from these particularities to find
some nugget of valuable practices that have a more general application.
Design patterns are a collection of reusable tried and tested solutions to recurring
problems in engineering. They make our software more modular, maintainable, and extensible.
Moreover, these patterns provide a common language for developers to use, making them
an excellent tool for effective communication when problem-solving in teams.
Copy link
Contributor

@pickfire pickfire Feb 27, 2022

Choose a reason for hiding this comment

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

Can you please split this into 2 paragraphs? It seemed quite long to read.

Also, I think the english words it uses is way harder compared to the original one, I think some people may have difficulties reading this.

Copy link
Contributor

@neithernut neithernut Feb 28, 2022

Choose a reason for hiding this comment

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

Also, I think the english words it uses is way harder compared to the original one, I think some people may have difficulties reading this.

Imo it should be ok as it's part of the introduction, which many readers will skip anyway. Clarity is not as important here as it is elsewhere.
Can you point out a specific phrase that could be problematic to non-native speakers?

Copy link
Contributor

@pickfire pickfire Feb 28, 2022

Choose a reason for hiding this comment

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

Can you point out a specific phrase that could be problematic to non-native speakers?

In my own opinion, at least I consider my english not that bad as compared to others non-native speakers (given english is my third spoken language and second written language). Here is what I think is hard:

  • solve the task at hand (proverb is harder and different communities may have different proverbs)
  • abstract from these particularities (this one I am not clear myself)
  • find some nugget of valuable practices (nugget? food is what came to my mind at first, I can only guess the meaning)
  • recurring problems
  • problem-solving in teams (this can be solving problem in teams, first time I heard problem-solving)

At least I think rather than asking me, ask yourself whether a five years old kid (or just go ask a real kid) can understand the words.

Some parts have words used that don't provide much clarity or wasted I think.

  • share similarities regardless of the environment they appear in (environment here is not clear enough, even when removed the meaning did not changed so I guess can just remove)
  • making them an excellent tool for effective communication (I think can just say these patterns are given names for easier discussion)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree with the point you make about separating the paragraph into two and that's about it.

intro.md Show resolved Hide resolved
@MarkoM-dot MarkoM-dot closed this Feb 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants