From fd6dc7160bf2af767626245054c85fe1608a64fa Mon Sep 17 00:00:00 2001 From: "Tom Bui [SSW]" <67776356+tombui99@users.noreply.github.com> Date: Wed, 10 Apr 2024 12:41:35 +1000 Subject: [PATCH] =?UTF-8?q?XS=E2=9C=94=20=E2=97=BE=20Fixed=20OK=20spelling?= =?UTF-8?q?=20mistakes=20(#8337)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Fixed OK spelling mistakes * Auto-fix Markdown files --------- Co-authored-by: github-actions[bot] --- .../rule.md | 39 ++++++++++--------- rules/business-cards-branding/rule.md | 6 +-- rules/desk-setups/rule.md | 5 +-- .../rule.md | 2 +- .../rule.md | 2 +- .../do-you-avoid-using-out-of-office/rule.md | 6 +-- rules/do-you-use-gzip/rule.md | 2 +- rules/document-discoveries/rule.md | 12 +++--- rules/follow-up-effectively/rule.md | 2 +- rules/forms-value/rule.md | 10 ++--- .../rule.md | 2 +- .../rule.md | 6 +-- .../manage-youtube-livestream-content/rule.md | 12 +++--- .../rule.md | 2 +- .../minimize-unrelated-interruptions/rule.md | 2 +- rules/review-automated-tests/rule.md | 16 ++++---- .../rule.md | 4 +- rules/tell-chatgpt-to-ask-questions/rule.md | 2 +- rules/ticks-crosses/rule.md | 27 ++++++------- 19 files changed, 78 insertions(+), 81 deletions(-) diff --git a/rules/angular-separate-component-concerns/rule.md b/rules/angular-separate-component-concerns/rule.md index 7b4027b60c6..6b2da550a5d 100644 --- a/rules/angular-separate-component-concerns/rule.md +++ b/rules/angular-separate-component-concerns/rule.md @@ -17,22 +17,22 @@ One common mistake in writing a front-end component is trying to fit everything ## 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 -- 🟢 Easier to write -- 🟢 Less problem with reactivity -- ❌ No clear separation of logics -- ❌ Harder to debug when things go wrong -- ❌ Adding more features to this component can be challenging +* 🟢 Less file footprint +* 🟢 Easier to write +* 🟢 Less problem with reactivity +* ❌ No clear separation of logics +* ❌ Harder to debug when things go wrong +* ❌ Adding more features to this component can be challenging Consider splitting your component's logic when: -- The file has reached 100+ lines of code -- The component has two or more sources of data (e.g. route params and API) -- UI has many fields that need to be populated from a data source -- When it is not clear which data source drives the UI or when you want to abstract it out - +* The file has reached 100+ lines of code +* The component has two or more sources of data (e.g. route params and API) +* UI has many fields that need to be populated from a data source +* When it is not clear which data source drives the UI or when you want to abstract it out ## How to separate the logic? @@ -61,16 +61,17 @@ private calculate(...): ComponentData { // Calculate implementation } ``` + ::: bad Figure: Massive amount of code intermingling from API calls to calculation to UI binding ::: - Here are the steps to split the logic: + 1. Group front-end logic into these processes: - - Data fetching: fetching data from external sources - - Data processing: processing source data to suit the UI better - - Data display: binding the UI displayed element to a value + * Data fetching: fetching data from external sources + * Data processing: processing source data to suit the UI better + * Data display: binding the UI displayed element to a value 2. Identify which part of a smart component belongs to which process. @@ -107,6 +108,7 @@ Here are the steps to split the logic: // Calculate implementation } ``` + ::: good Figure: Use declarative code to bind UI value ::: @@ -158,11 +160,11 @@ Here are the steps to split the logic: }); } ``` + ::: good Figure: UI logic is separated from Data Fetching and Data Processing logic ::: - 5. (Optional) If the component is complex enough, consider splitting the data fetching with the data processing step to another component. In the example below, we create a parent component to handle the routing while providing the child component with the only necessary data. @@ -201,6 +203,7 @@ Here are the steps to split the logic: }); } ``` + ::: good Figure: All logics (data fetching, data processing, and data display) are now separated - ::: \ No newline at end of file + ::: diff --git a/rules/business-cards-branding/rule.md b/rules/business-cards-branding/rule.md index ae661a48e73..6328aaf2781 100644 --- a/rules/business-cards-branding/rule.md +++ b/rules/business-cards-branding/rule.md @@ -55,7 +55,7 @@ Digital business cards offer a range of advantages over their paper counterparts Here are the instructions for adding a digital business card to your phone wallet using the HiHello app: -1. **Download and install the HiHello app:** Visit your app store (iOS or Android) and search for "HiHello." Download and install the app on your smartphone. https://www.hihello.me/ +1. **Download and install the HiHello app:** Visit your app store (iOS or Android) and search for "HiHello." Download and install the app on your smartphone. 2. **Create your digital business card:** Open the HiHello app and sign up or log in to your account. Follow the prompts to create your digital business card by entering your contact details, choosing a template, and customizing the design to your preference. 3. **Save your digital business card to your phone wallet:** Once your digital business card is created, follow these steps to add it to your phone wallet: @@ -74,10 +74,10 @@ 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 ![Figure: Good Example - Digital Business Cards such as HiHello are awesome!](dsdsvcsd.png) -::: \ No newline at end of file +::: diff --git a/rules/desk-setups/rule.md b/rules/desk-setups/rule.md index 65ee9ba6a80..8c3a9408db2 100644 --- a/rules/desk-setups/rule.md +++ b/rules/desk-setups/rule.md @@ -26,14 +26,13 @@ To avoid this hassle and boost productivity, each desk should have a dock setup ![Figure: Good Example - Clean desk with a dock](good-clean-desks.png) ::: -If you have a Thinkpad dock, MacOS users will need to install a driver to use it. +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 1. Update OS 2. Update/install drivers 3. Restart your computer - diff --git a/rules/disagreeing-with-powerful-stakeholders/rule.md b/rules/disagreeing-with-powerful-stakeholders/rule.md index 5d61a174bbf..c4c451b083f 100644 --- a/rules/disagreeing-with-powerful-stakeholders/rule.md +++ b/rules/disagreeing-with-powerful-stakeholders/rule.md @@ -52,7 +52,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! ::: diff --git a/rules/do-you-add-end-screen-to-your-youtube-videos/rule.md b/rules/do-you-add-end-screen-to-your-youtube-videos/rule.md index 943873f0cb4..ac53d569008 100644 --- a/rules/do-you-add-end-screen-to-your-youtube-videos/rule.md +++ b/rules/do-you-add-end-screen-to-your-youtube-videos/rule.md @@ -26,7 +26,7 @@ On top of [YouTube Cards](/youtube-cards), you can also add an end screen for th -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: diff --git a/rules/do-you-avoid-using-out-of-office/rule.md b/rules/do-you-avoid-using-out-of-office/rule.md index 83a26e8dc1e..8857136b2b7 100644 --- a/rules/do-you-avoid-using-out-of-office/rule.md +++ b/rules/do-you-avoid-using-out-of-office/rule.md @@ -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). @@ -46,10 +46,10 @@ The use of 'Out of Office - Automated Response' emails should be avoided unless If you are on leave or unavailable for a period and want your team to know, you should set your status to Out of Office. A recurring problem when doing this in Outlook is that if a user selects their meeting to show them ‘Out of office’, whoever accepts the appointment will also have their status changed to ‘Out of office’. -In case you use Outlook and Microsoft Teams, there’s a quick way to do this. You can use **Edit status message | Out of Office** feature on Teams. +In case you use Outlook and Microsoft Teams, there’s a quick way to do this. You can use **Edit status message | Out of Office** feature on Teams. By using this feature, your Teams status will be synchronized to Outlook, showing the whole organization that you are not available for calls or meetings. You can even set up an automatic message to be sent when someone tries to reach you on Microsoft Teams. ::: good ![Figure: Good example - Your new status on Teams will be shared across your Outlook calendar, and your team will see you are not around](teams-status.jpg) -::: \ No newline at end of file +::: diff --git a/rules/do-you-use-gzip/rule.md b/rules/do-you-use-gzip/rule.md index 2f0d05482d6..17781c9acfd 100644 --- a/rules/do-you-use-gzip/rule.md +++ b/rules/do-you-use-gzip/rule.md @@ -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) diff --git a/rules/document-discoveries/rule.md b/rules/document-discoveries/rule.md index e5702288942..3acd66383b8 100644 --- a/rules/document-discoveries/rule.md +++ b/rules/document-discoveries/rule.md @@ -57,15 +57,15 @@ Keeping Work Items as up-to-date as possible ensures that the information is rec ### How do you document changes? -Now, you might be wondering about the best approach for recording a change. +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. +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. -Using the Work Item discussion provides several benefits to developers on the team, including: +Using the Work Item discussion provides several benefits to developers on the team, including: ::: good Providing one source of truth @@ -99,7 +99,7 @@ Provides proof of approval | Subject: | Project - Work Item Update | ::: email-content -### Hi Bob, +### Hi Bob As per our conversation, the primary button colour does not conform with the Northwind branding. The colour will be updated to #CC4141. ::: @@ -117,6 +117,6 @@ Figure: Bad example - Sending an email to confirm updates to the work item ![Figure: Bad example - Moving a PBI to the backlog without documenting the decision](./images/Bad-example-Adding-and-Item-to-the-backlog.jpg "PBI Backlog") ::: -::: good +::: good ![Figure: Good example - Moving a PBI to the backlog and documenting the decision](./images/Good-example-Adding-and-Item-to-the-backlog.jpg "PBI Backlog") ::: diff --git a/rules/follow-up-effectively/rule.md b/rules/follow-up-effectively/rule.md index 404ec92a8a3..76fbba7599e 100644 --- a/rules/follow-up-effectively/rule.md +++ b/rules/follow-up-effectively/rule.md @@ -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 diff --git a/rules/forms-value/rule.md b/rules/forms-value/rule.md index 103dcfcb05c..ed36b005f5f 100644 --- a/rules/forms-value/rule.md +++ b/rules/forms-value/rule.md @@ -10,7 +10,7 @@ guid: 3d41f831-c7d7-4e80-81b1-2bd2a7f36a26 --- Microsoft Forms and Google Forms provide an invaluable way of collecting data from your employees, users and other stakeholders. It's important to understand if their experience of providing this feedback is a good or a bad one. -Therefore, create a last question where they rate the form's questions from their perspective. That way you've got metrics to make better forms in the future. +Therefore, create a last question where they rate the form's questions from their perspective. That way you've got metrics to make better forms in the future. Let's take a look... @@ -20,7 +20,7 @@ There are 2 steps to getting objective data about forms. ### 1 - Measure the value -The best way to measure value is simply to ask your users. Put a question at the bottom of your form and ask them to give it a rating out of 5. +The best way to measure value is simply to ask your users. Put a question at the bottom of your form and ask them to give it a rating out of 5. ![Figure: Add a question asking your users for the value of the form (make sure the question is always the same)](askthevalueofyourform.png) @@ -34,12 +34,12 @@ However, simply asking the question is not enough. Most people will answer a for In particular, new people are enthusiastic and want to give everything 5 out of 5. They are often surprised when they find out this isn't helpful -The general guidance should be to compare the value against previous entries. For example, the scale should be something like: +The general guidance should be to compare the value against previous entries. For example, the scale should be something like: * Terrible - 1 * Poor - 2 -* Okay - 3 +* OK - 3 * Good - 4 * Outstanding - 5 -If you educate the users about this, your data is going to be much more reflective of the actual value each form gives. \ No newline at end of file +If you educate the users about this, your data is going to be much more reflective of the actual value each form gives. diff --git a/rules/implement-business-logic-in-middle-tier/rule.md b/rules/implement-business-logic-in-middle-tier/rule.md index a52a9308d66..af907b3dfe2 100644 --- a/rules/implement-business-logic-in-middle-tier/rule.md +++ b/rules/implement-business-logic-in-middle-tier/rule.md @@ -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. diff --git a/rules/make-complaints-a-positive-experience/rule.md b/rules/make-complaints-a-positive-experience/rule.md index 2697d85d75b..f11559ac0f3 100644 --- a/rules/make-complaints-a-positive-experience/rule.md +++ b/rules/make-complaints-a-positive-experience/rule.md @@ -35,11 +35,11 @@ When you get the call/email, how you respond can make or break the relationship. If you need help with this, [learn how to take feedback/criticism (even if it’s not your fault)](/how-to-take-feedback-or-criticism/). ::: - If solving the issue(s) is within your power, you should action it (or put a plan into motion) right away. But this may not always be the case - maybe you're a developer and the customer is upset about an invoice. In that case... + If solving the issue(s) is within your power, you should action it (or put a plan into motion) right away. But this may not always be the case - maybe you're a developer and the customer is upset about an invoice. In that case... 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 @@ -64,7 +64,7 @@ Someone will complain about what you do no matter how 'perfect' you are. That do **Remember:** It's important to resolve a client's complaint because studies have shown that: -* For every customer that complains, there may be 26 others that will not tell you they are dissatisfied. +* For every customer that complains, there may be 26 others that will not tell you they are dissatisfied. Of this 26: * Up to 19 will not come back diff --git a/rules/manage-youtube-livestream-content/rule.md b/rules/manage-youtube-livestream-content/rule.md index 170a2891d74..b1bdd12f414 100644 --- a/rules/manage-youtube-livestream-content/rule.md +++ b/rules/manage-youtube-livestream-content/rule.md @@ -15,7 +15,7 @@ Firstly, live streaming can be challenging and stressful for the host or present Secondly, editing a livestream after the fact can be time-consuming and tedious. The raw footage may include mistakes, tangents, or other content that needs to be removed in order to create a polished final product. This can be a daunting task, especially for those who are new to video editing. -Thirdly, as of 27 Oct 2022, Shorts and live streams no longer appear in the videos tab. It’s now split into 3 categories: +Thirdly, as of 27 Oct 2022, Shorts and live streams no longer appear in the videos tab. It’s now split into 3 categories: 1. SHORTS 2. LIVE @@ -23,14 +23,14 @@ Thirdly, as of 27 Oct 2022, Shorts and live streams no longer appear in the vide ![Figure: Videos, Shorts, and Live tabs on your YouTube channel](rules/manage-youtube-livestream-content/Videos-shorts-live.jpg) -Read more here - https://www.dexerto.com/entertainment/youtube-separate-tabs-live-streams-videos-shorts-1970225/ +Read more here - 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 +* Live is archived or zz'd ✅Consistent ✅Shows UserGroup on videos tab ❌Lose views and engagement @@ -45,7 +45,7 @@ With this in mind, there are several options you can do to manage your live-stre * Add it to a playlist and make that playlist prominent on the YouTube home page\ ✅Engagement - Keeps views and comments ✅Cheap - ✅Faster in outputting content + ✅Faster in outputting content ❌Less consistent ❌Stuck in the Live tab @@ -74,6 +74,4 @@ Add an annotation in your unedited livestream to link to the nice edited video ![Figure: Edited version showing in Video Tab](rules/manage-youtube-livestream-content/Videos-Tab.jpg) - - Overall, there are a number of challenges associated with live streaming to YouTube and editing the livestream for re-publication. However, with the right approach and tools, these challenges can be overcome, and a high-quality, engaging video can be created. diff --git a/rules/management-do-you-know-who-has-authority/rule.md b/rules/management-do-you-know-who-has-authority/rule.md index de4acdb9f63..09d2ebc2d85 100644 --- a/rules/management-do-you-know-who-has-authority/rule.md +++ b/rules/management-do-you-know-who-has-authority/rule.md @@ -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. diff --git a/rules/minimize-unrelated-interruptions/rule.md b/rules/minimize-unrelated-interruptions/rule.md index 9b59c2351e2..06f335b81c9 100644 --- a/rules/minimize-unrelated-interruptions/rule.md +++ b/rules/minimize-unrelated-interruptions/rule.md @@ -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. diff --git a/rules/review-automated-tests/rule.md b/rules/review-automated-tests/rule.md index ef36c501c27..8ee9ec9c0ea 100644 --- a/rules/review-automated-tests/rule.md +++ b/rules/review-automated-tests/rule.md @@ -14,14 +14,12 @@ Reliable suites of automated tests can provide a lot of value to your developmen The more automated the process of building, testing, deploying and delivering software is (and that's the direction a lot of teams are going in), the higher the responsibility of our tests is. Increasingly often, our tests are the only safety net (change detector) between code being written on a developer machine and that code ending up in a production environment. Therefore, it's probably a good idea to make sure that our tests detect the changes we want them to detect. - - Automated test code ages just like any other code, though, and it's common to see teams adding more and more automated tests to their suites, without ever going back to review the existing tests to see if they're still relevant and adding value. This process of adding further tests over time often results in bloated test suites that take **longer to run** and require **more human effort** to diagnose failures. Your automated tests require periodic attention and review — or else they're like smoke detectors, scattered throughout enormous buildings, whose batteries and states of repair are uncertain. As Jerry Weinberg said: > Most of the time, a non-functioning smoke alarm is behaviorally indistinguishable from one that works. Sadly, the most common reminder to replace the batteries is a fire." -> - Jerry Weinberg +> - Jerry Weinberg @@ -37,9 +35,9 @@ Your automated tests are a valuable asset but only when they are relevant and va ### Is the test still relevant? -As the product changes over time, older tests can easily still run and pass but are checking for conditions that are no longer relevant. +As the product changes over time, older tests can easily still run and pass but are checking for conditions that are no longer relevant. -It may even be the case that tests can no longer fail as the product has evolved, so there is simply no point in running them any more. +It may even be the case that tests can no longer fail as the product has evolved, so there is simply no point in running them any more. ### Is the test adding value? @@ -56,14 +54,14 @@ The total cost of a test is significant, when you take into account: So, the value of a test really needs to justify its cost. If a test is not mitigating enough risk or providing enough valuable information compared to its cost, then consider deleting (or at least simplifying) it. -## Don't be fooled by "green" tests! +## Don't be fooled by "green" tests Teams can become very focused on achieving "green builds" where all of their automated tests pass during their build pipelines. ::: greybox **Tip:** "All green" doesn't necessarily mean "all good"! -False negatives are the silent killers, the tests that show a pass but let a change slip by undetected. +False negatives are the silent killers, the tests that show a pass but let a change slip by undetected. ::: In his blog post on [flaky testing](https://developsense.com/blog/2021/02/flaky-testing), Michael Bolton makes an important point about your "green" tests: @@ -74,11 +72,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." diff --git a/rules/take-care-of-your-personal-presentation-for-remote-meetings/rule.md b/rules/take-care-of-your-personal-presentation-for-remote-meetings/rule.md index 7e9221eea0c..620e966c93d 100644 --- a/rules/take-care-of-your-personal-presentation-for-remote-meetings/rule.md +++ b/rules/take-care-of-your-personal-presentation-for-remote-meetings/rule.md @@ -18,18 +18,16 @@ 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. Try to start your day afresh, as you would usually do to go to your workplace. Follow your usual morning routine: shower, dress, eat breakfast, and then start your work routine. - ::: bad ![Bad example - Figure: Not dressing accordingly or not having a work station from home can drastically reduce your concentration](dressing-meeting-bad.jpg) ::: - ::: good ![Good example - Figure: Nice work station and good personal presentation whilst working from home](dressing-meeting-good.jpg) ::: diff --git a/rules/tell-chatgpt-to-ask-questions/rule.md b/rules/tell-chatgpt-to-ask-questions/rule.md index 13a11536335..64c8f5b1498 100644 --- a/rules/tell-chatgpt-to-ask-questions/rule.md +++ b/rules/tell-chatgpt-to-ask-questions/rule.md @@ -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. diff --git a/rules/ticks-crosses/rule.md b/rules/ticks-crosses/rule.md index 8c4bbb932a6..786f03da7f2 100644 --- a/rules/ticks-crosses/rule.md +++ b/rules/ticks-crosses/rule.md @@ -23,11 +23,11 @@ Using ticks and crosses in the **will help you emphasize an example and aid comp A good tick and cross example will have: * A graphic - Not intrusive on the content and left aligned -* A subtle sound - Significantly lower than the human voice +* A subtle sound - Significantly lower than the human voice -**Note:** Using a blend of tick and cross visuals with sound cues will reinforce for your audience which example is good and which is bad. +**Note:** Using a blend of tick and cross visuals with sound cues will reinforce for your audience which example is good and which is bad. -### ❌ Bad example #1 - No visuals or sounds +### ❌ Bad example #1 - No visuals or sounds **Video: [SSW TV - Do you have a product roadmap? | 0:38 - 0:48](https://youtu.be/FXMMZvE1lig?t=38)** @@ -41,7 +41,7 @@ The video presents good and bad examples without using other visual elements or **Video: [SSW TV - Do you check before installing 3rd party libraries? | 0:59 - 1:02](https://youtu.be/1LPK3jgga_c?t=59)** -Ticks and crosses with sound effects are used in the video, but there are still problems: +Ticks and crosses with sound effects are used in the video, but there are still problems: * Distracting ticks and crosses - the visuals are too large and placed in the middle of the frame so they draw the audience's attention away from the content. * Loud sound - When the sound effect is significantly louder than the human voice, it can cause an unpleasant auditory effect. @@ -56,16 +56,16 @@ Therefore, it is important to use an appropriately sized graphic left-aligned (s **Video: [SSW TV - Documenting decisions and discoveries with Piers Sinclair | 1:54 - 2:02](https://youtu.be/2Ff6NQrWMsY?t=114)** -This is an OK example using crosses in a video: +This is an OK example using crosses in a video: -* Good size - smaller than the figure in the picture, not visually obtrusive -* Good location - in the margin below the email signature, not covering the example, but drawing the audience's attention to it -* Subtle sound effect - the sound effect is lower than the speaker's voice +* Good size - smaller than the figure in the picture, not visually obtrusive +* Good location - in the margin below the email signature, not covering the example, but drawing the audience's attention to it +* Subtle sound effect - the sound effect is lower than the speaker's voice -However...it would be an even better approach to standardise your ticks and crosses so you can use the same graphic across every 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 @@ -85,7 +85,7 @@ Standarding your ticks and crosses using a lower third helps the team have a con ### Extra - SSW TV Research: Feedback on videos using ticks and crosses -In a weekly internal form known as "'Chewing the Fat', the SSW TV Team set three questions for SSW employees to answer: +In a weekly internal form known as "'Chewing the Fat', the SSW TV Team set three questions for SSW employees to answer: * **Question #1** - With sound or without sound: Video Ticks and Crosses - Did you like them? * **Question #2** - Subtle sound or loud sound: Video Ticks and Crosses - Did you like them? @@ -127,7 +127,7 @@ The final results (including other) were: * 78% prefer to have subtle sound * 11% prefer no ticks and crosses at all * 7% prefer to have loud sound -* 4% prefer to have no sound +* 4% prefer to have no sound #### Results - Question #3 - Comparison: Video Ticks and Crosses V3 - What are your thoughts on the sound? @@ -150,7 +150,7 @@ The final results (including other) were: #### Results - Question #4 - Which subtle sound is perfect: Video Ticks and Crosses - Did you like them? -**Video #4: [SSW TV - No Hello - Boost Productivity: Say Goodbye to Time Wasting with this Simple Trick | SSW Rules | 1:05 – 1:21 ](https://youtu.be/oOEpdViHeVI?t=65)** +**Video #4: [SSW TV - No Hello - Boost Productivity: Say Goodbye to Time Wasting with this Simple Trick | SSW Rules | 1:05 – 1:21](https://youtu.be/oOEpdViHeVI?t=65)** ![Figure: The good example with a more subtle sound](video-4-.png) @@ -161,6 +161,7 @@ The final results (including other) were: After watching video #3, people prefer the subtle sound this time to [the subtle sound in video#2](https://youtu.be/2Ff6NQrWMsY?t=96). Of the 1 other response, no accurate assessment of how good or bad the two sounds were. The final results (including Other) were: + * 60% prefer to have subtle sound in video #4 * 14% prefer to have a more subtle sound * 13% prefer to have ticks and crosses without sound