Skip to content

Commit

Permalink
Fixed OK spelling mistakes
Browse files Browse the repository at this point in the history
  • Loading branch information
tombui99 committed Apr 10, 2024
1 parent 2c66156 commit 8f4e6ea
Show file tree
Hide file tree
Showing 19 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion rules/angular-separate-component-concerns/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ One common mistake in writing a front-end component is trying to fit everything
<!--endintro-->

## Why should you separate the logic?
In simple components, having many logics (e.g. API calls and binding to the form) written to the component itself sometimes works okay, especially if the aim is to reduce the file footprint. However, doing this to larger-sized components can make maintaining the code challenging. The last thing developers want to do is debug a component with 1000+ lines of code with intermingling logic.
In simple components, having many logics (e.g. API calls and binding to the form) written to the component itself sometimes works OK, especially if the aim is to reduce the file footprint. However, doing this to larger-sized components can make maintaining the code challenging. The last thing developers want to do is debug a component with 1000+ lines of code with intermingling logic.

Pros and cons of combining all logic into a single component:
- 🟢 Less file footprint
Expand Down
2 changes: 1 addition & 1 deletion rules/business-cards-branding/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Here are the instructions for adding a digital business card to your phone walle
* Follow the prompts to select the saved image of your digital business card from your gallery or files.
4. **Access and share your digital business card:** Once your digital business card is saved in your phone wallet, you can easily access it anytime by opening your wallet app. You can then share it with others by tapping on the card and selecting the sharing option provided by your wallet app.

![Figure: Ok example: If you are going to have Paper Business cards, make sure they POP!](ssw-businesscards.png)
![Figure: OK example: If you are going to have Paper Business cards, make sure they POP!](ssw-businesscards.png)

::: good

Expand Down
2 changes: 1 addition & 1 deletion rules/desk-setups/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ To avoid this hassle and boost productivity, each desk should have a dock setup
If you have a Thinkpad dock, MacOS users will need to install a driver to use it.
See [DisplayLink Manager.](https://www.synaptics.com/products/displaylink-graphics/downloads/macos)

There are some rare scenarios where people won't use docks. This is okay, but you need to ensure the desk is set up properly for the next user. All cables should use the dock wherever possible.
There are some rare scenarios where people won't use docks. This is OK, but you need to ensure the desk is set up properly for the next user. All cables should use the dock wherever possible.

If you are having issues with the docks, try these steps

Expand Down
2 changes: 1 addition & 1 deletion rules/disagreeing-with-powerful-stakeholders/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Good example - The Developer identified that the Product Owner had a different r
Getting permission to comment is a great tactic. It makes the stakeholder feel empowered to have the conversation and also gives you confidence that they are interested in what you have to say.

:::greybox
**Developer**: Would it be okay if I explain why I think we should upgrade now?
**Developer**: Would it be OK if I explain why I think we should upgrade now?

**Product Owner**: Sure!
:::
Expand Down
2 changes: 1 addition & 1 deletion rules/do-you-add-end-screen-to-your-youtube-videos/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ On top of [YouTube Cards](/youtube-cards), you can also add an end screen for th

<!--endintro-->

End screens help to avoid viewers to go away by suggesting to them the next content they can watch. The idea remains similar to cards `\*LINKBACKANDFORTH\*:` you display a CTA to your viewers so they can watch more of your content. End screens tend to work better (viewers can decide to ignore cards to keep watching the video which is okay as it increases the chance they will finish your video- increasing session time), as viewers are now done with your video and need to look for another video to watch.
End screens help to avoid viewers to go away by suggesting to them the next content they can watch. The idea remains similar to cards `\*LINKBACKANDFORTH\*:` you display a CTA to your viewers so they can watch more of your content. End screens tend to work better (viewers can decide to ignore cards to keep watching the video which is OK as it increases the chance they will finish your video- increasing session time), as viewers are now done with your video and need to look for another video to watch.

Hold their hand by promoting up to four elements which can be:

Expand Down
2 changes: 1 addition & 1 deletion rules/do-you-avoid-using-out-of-office/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ When you are on leave, you need to make sure that your mailbox is monitored. The

* For extended periods off the grid, asking someone (nicely) to check your mailbox if you are away for 3 days or more. This ensures that any important emails from clients are actioned,
* Make sure all client emails are handled before you leave; either delegate the task, or inform the person taking care of your inbox or,
* Check it yourself every 3-4 days from home or wherever you are (a Hawaiian beach or Himalayan mountain maybe!). People are generally okay waiting a couple of days for a reply. **For extended periods off the grid, the use of ‘Out of office’ is good** , but when you expect to have partial connectivity and anticipate replying, don't set your ‘Out of office’ on at all.
* Check it yourself every 3-4 days from home or wherever you are (a Hawaiian beach or Himalayan mountain maybe!). People are generally OK waiting a couple of days for a reply. **For extended periods off the grid, the use of ‘Out of office’ is good** , but when you expect to have partial connectivity and anticipate replying, don't set your ‘Out of office’ on at all.

The use of 'Out of Office - Automated Response' emails should be avoided unless you plan to be away for more than a week, and unable to check your emails while away. In this case, it is also good to mention one or two alternative contact(s).

Expand Down
2 changes: 1 addition & 1 deletion rules/do-you-use-gzip/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Use one of the methods described below to add Gzip compression to your site ASP.
In **Control Panel** navigate to **All Control Panel Items | Programs and Features**, and click **Turn Windows features on or off**.
Choose **Internet Information Services | Web Management Tools | World Wide Web Services | Performance Features | Dynamic Content Compression**.

![Figure: Click "Ok" to install it](use-gzip-4.png)
![Figure: Click "OK" to install it](use-gzip-4.png)

![Figure: Enable dynamic content compression for your site](use-gzip-5.png)

Expand Down
2 changes: 1 addition & 1 deletion rules/document-discoveries/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Now, you might be wondering about the best approach for recording a change.

Noting it down seems like a good idea, but the problem with that approach is that it quickly gets lost or forgotten about and isn't recorded in a regularly checked place.

Sending an email is an okay approach, but the information will quickly be lost, buried under hundreds of other emails, unseen by anyone who might need to see it later on. Additionally, the audit trail is poor since there is no consistent thread.
Sending an email is an OK approach, but the information will quickly be lost, buried under hundreds of other emails, unseen by anyone who might need to see it later on. Additionally, the audit trail is poor since there is no consistent thread.

The best method is for developers to **update the discussion thread of the Work Item** they're working on. Then, if an email is really needed, send a link to the Work Item.

Expand Down
2 changes: 1 addition & 1 deletion rules/follow-up-effectively/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ To ensure you follow up on tasks, it is important to set up an action point so i

### The Tools

There are some okay tools like delayed send and follow up flags... but the our Top 10 gold standard tools are:
There are some OK tools like delayed send and follow up flags... but the our Top 10 gold standard tools are:

1. Email - Followupthen.com
2. Outlook | Schedule Send
Expand Down
2 changes: 1 addition & 1 deletion rules/forms-value/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The general guidance should be to compare the value against previous entries. Fo

* Terrible - 1
* Poor - 2
* Okay - 3
* OK - 3
* Good - 4
* Outstanding - 5

Expand Down
2 changes: 1 addition & 1 deletion rules/implement-business-logic-in-middle-tier/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ Implementing business logic in stored procedures have the disadvantage of being

With the exception of some very heavy data oriented operations, it is excusable to use stored procedures to carry out some logic for performance reasons.

Triggers are even more difficult as their behaviour is event based.  It is okay to use triggers for non-functional/infrastructural features such as logging changes or maintain more complex relational integrity which cannot be enforced by a simple relationship.
Triggers are even more difficult as their behaviour is event based.  It is OK to use triggers for non-functional/infrastructural features such as logging changes or maintain more complex relational integrity which cannot be enforced by a simple relationship.

<!--endintro-->
2 changes: 1 addition & 1 deletion rules/make-complaints-a-positive-experience/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ When you get the call/email, how you respond can make or break the relationship.
3. **Conference in the appropriate resources**. While you have the client on the call, don't let them go

::: greybox
Okay, let's try and get this sorted right now. Is it okay with you if I bring in {{ RELEVANT PERSON }} to help work this out?
OK, let's try and get this sorted right now. Is it OK with you if I bring in {{ RELEVANT PERSON }} to help work this out?
:::

::: good
Expand Down
2 changes: 1 addition & 1 deletion rules/manage-youtube-livestream-content/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Read more here - https://www.dexerto.com/entertainment/youtube-separate-tabs-liv

With this in mind, there are several options you can do to manage your live-stream video content, each with its own pros and cons:

## Option 1 - Complete Consistency (Okay)
## Option 1 - Complete Consistency (OK)

* After the livestream, take it down and upload it so it shows in the videos tab
* Live is archived or zz'd
Expand Down
2 changes: 1 addition & 1 deletion rules/management-do-you-know-who-has-authority/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ archivedreason: null
guid: 6fbff901-97cc-4f48-82d0-de4e30b8c37f
---

Ok, once a project gets going, you can end up dealing with many people on the client side. From the Boss to the Business Decision Maker (we call them the "Product Owner") through to Mary the receptionist (aka "users"), everyone has something to say about the software as it is being developed. However, when you are working on a Time & Materials basis in a rapid development environment with continually changing specs, you have to be certain that the work you are doing is authorised by the person who signs the cheques.
OK, once a project gets going, you can end up dealing with many people on the client side. From the Boss to the Business Decision Maker (we call them the "Product Owner") through to Mary the receptionist (aka "users"), everyone has something to say about the software as it is being developed. However, when you are working on a Time & Materials basis in a rapid development environment with continually changing specs, you have to be certain that the work you are doing is authorised by the person who signs the cheques.

<!--endintro-->

Expand Down
2 changes: 1 addition & 1 deletion rules/minimize-unrelated-interruptions/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ See this cool suggestion to [make BRB a built-in feature on Microsoft Teams](htt

Another way to keep the group call smooth is to mute your mic if someone comes to talk to you in person. This avoids distracting background noise.

**Be mindful** of people talking or other noises that might be registering into your microphone. It's okay to turn away for a minute, as long as you mute to keep the call free from random noise.
**Be mindful** of people talking or other noises that might be registering into your microphone. It's OK to turn away for a minute, as long as you mute to keep the call free from random noise.
4 changes: 2 additions & 2 deletions rules/review-automated-tests/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,11 @@ In his blog post on [flaky testing](https://developsense.com/blog/2021/02/flaky-
>Suppose you're on a team of 10 people, responsible for 100,000 checks. To review those annually requires each person working solo to review 10,000 checks a year. That's 50 per person (or 100 per pair) every working day of the year. Does your working day include that?
>Here’s a question worth asking, then: if 10% of 100 red checks are misleadingly signalling a problem, what percentage of 99,900 green checks are misleadingly signalling “no problem”? They're running green, so no one looks at them. They’re probably okay. But even if your unreviewed green checks are ten times more reliable than the red checks that got your attention (because they’re red), that's 1%. That’s 999 misleadingly green checks.
>Here’s a question worth asking, then: if 10% of 100 red checks are misleadingly signalling a problem, what percentage of 99,900 green checks are misleadingly signalling “no problem”? They're running green, so no one looks at them. They’re probably OK. But even if your unreviewed green checks are ten times more reliable than the red checks that got your attention (because they’re red), that's 1%. That’s 999 misleadingly green checks.
This is where regular review can help us, as Michael notes in his blog post, [On green](https://developsense.com/blog/2015/07/on-green):

> When the check runs green, it's easy to remain relaxed. The alarm doesn’t sound; the emergency lighting doesn't come on; the dog doesn't bark. If we're insufficiently attentive and skeptical, every green check helps to confirm that everything is okay.
> When the check runs green, it's easy to remain relaxed. The alarm doesn’t sound; the emergency lighting doesn't come on; the dog doesn't bark. If we're insufficiently attentive and skeptical, every green check helps to confirm that everything is OK.
When we have unjustified trust in our checks, we have the opposite problem that we have with the smoke detector: we're unlikely to notice that the alarm doesn’t go off when it should.

> We can choose to hold on to the possibility that something might be wrong with our checks, and to identify the absence of red checks as meta-information; a suspicious silence, instead of a comforting one. The responsible homeowner checks the batteries on the smoke alarm."
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ redirects:

---

Some people might think that if they are working from home it’s okay to wear pyjamas or not brush their hair. However, if you change into your usual dress code, you will feel more motivated and ready to work. Also, you will show professionalism by not wearing pyjamas and attending meetings as you would if you were there in person.
Some people might think that if they are working from home it’s OK to wear pyjamas or not brush their hair. However, if you change into your usual dress code, you will feel more motivated and ready to work. Also, you will show professionalism by not wearing pyjamas and attending meetings as you would if you were there in person.

<!--endintro-->

Expand Down
2 changes: 1 addition & 1 deletion rules/tell-chatgpt-to-ask-questions/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Sometimes, ChatGPT may require more context or clarification to provide a helpfu
Here are some tips for prompting ChatGPT to ask for more context:

* Invite ChatGPT to ask for clarification in the initial prompt if necessary
* Emphasize that it's okay to ask questions if the model doesn't have enough information
* Emphasize that it's OK to ask questions if the model doesn't have enough information
* Be prepared to provide additional details if ChatGPT requests them
* Consider adding "On each prompt, let me know roughly how many questions are left", to gauge if you want to answer all questions
* If you’re feeling lazy or short for time, you can even get it to only ask you multiple choice questions.
Expand Down
2 changes: 1 addition & 1 deletion rules/ticks-crosses/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ This is an OK example using crosses in a video:
However...it would be an even better approach to standardise your ticks and crosses so you can use the same graphic across every video.

::: ok
![Figure: Ok example - Red cross with the right size + location + subtle sound - 1:54 - 2:02](good-example-1-red-cross-with-the-right-size-subtle-sound.png)
![Figure: OK example - Red cross with the right size + location + subtle sound - 1:54 - 2:02](good-example-1-red-cross-with-the-right-size-subtle-sound.png)
:::

### ✅ Good Example - Lower Thirds
Expand Down

0 comments on commit 8f4e6ea

Please sign in to comment.