Merge branch 'main' into Update-Better-Rules-To-SAFe-Folders

SSWConsulting · Apr 12, 2024 · 86befc0 · 86befc0
2 parents b8f190c + fc39378
commit 86befc0
Show file tree

Hide file tree

Showing 21 changed files with 72 additions and 62 deletions.
diff --git a/categories/company-operations/rules-to-better-accounting.md b/categories/company-operations/rules-to-better-accounting.md
@@ -32,8 +32,5 @@ index:
 - do-you-calculate-payroll-tax-correctly
 - do-you-check-your-customers-organisation-age-for-prepaid
 - do-you-treat-freebies-as-real-customers
-- show-long-service-leave-on-your-payslip
-- show-certification-award
-
 ---
 
diff --git a/categories/company-operations/rules-to-better-flights.md b/categories/company-operations/rules-to-better-flights.md
@@ -16,7 +16,6 @@ index:
   - do-you-keep-your-finance-manager-in-the-loop
   - use-qantas-bid-now-upgrades
   - do-you-know-the-best-online-accommodation-websites
-  - do-you-make-business-travel-easier
   - do-you-know-how-to-get-the-most-out-of-your-credit-card
   - do-you-take-advantage-of-business-rewards-programs
   - missing-flight-invoices

diff --git a/categories/project-delivery/rules-to-better-scaled-agile-framework.md b/categories/project-delivery/rules-to-better-scaled-agile-framework.md
@@ -7,8 +7,6 @@ experts: https://www.ssw.com.au/people/?skill=Scrum
 consulting: https://www.ssw.com.au/consulting/scrum
 index:
 - use-safe-to-align-multiple-scrum-teams
-- prioritise-value-streams-over-individual-projects
-- establish-a-Lean-Agile-mindset-across-all-teams
 - do-you-implement-DevOps-practices-for-continuous-delivery
 - do-you-utilize-a-release-train
 - do-you-involve-stakeholders-in-pi-planning

diff --git a/rules/bicep-user-defined-data-types/rule.md b/rules/bicep-user-defined-data-types/rule.md
@@ -5,8 +5,8 @@ guid: 2a3ba816-ba40-4cfe-8193-7e151e038ac5
 uri: bicep-user-defined-data-types
 created: 2024-03-19T19:19:19.1919191Z
 authors:
-- title: Rick Su
-  url: https://ssw.com.au/people/rick-su
+  - title: Rick Su
+    url: https://ssw.com.au/people/rick-su
 related: []
 redirects: []
 archivedreason: null

diff --git a/rules/business-cards-branding/rule.md b/rules/business-cards-branding/rule.md
@@ -77,7 +77,5 @@ Here are the instructions for adding a digital business card to your phone walle
 ![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)
-
 :::
diff --git a/rules/communicate-your-product-status/rule.md b/rules/communicate-your-product-status/rule.md
@@ -5,10 +5,10 @@ uri: communicate-your-product-status
 guid: b396caf5-9bfb-4607-bc69-7dc13700b3cc
 created: 2024-03-25T10:39:38.0000000Z
 authors:
-- title: Nick Curran
-  url: https://ssw.com.au/people/nick-curran
+  - title: Nick Curran
+    url: https://ssw.com.au/people/nick-curran
 related:
-- send-sprint-forecast-and-sprint-review-retro-emails-to-the-client
+  - send-sprint-forecast-and-sprint-review-retro-emails-to-the-client
 archivedreason: null
 ---
 
@@ -23,11 +23,13 @@ Keep stakeholders informed of progress and enthused about your project using mon
 To prepare for meetings and maximise the chances of success for your project, ensure you have answers to the following questions:
 
 1. **Value - What features have been delivered recently?** Celebrate your successes and demonstrate how your product is adding value to stakeholders. Examples could include:
+
     * A new login screen with better accessibility for visually impaired users
     * Support for a new business process
     * A shortened user registration process
 
 2. **Development - How has the Roadmap progressed?** A PBI is a small chunk of work conducted to progress a larger aim. Explain how the completion of these PBIs contributed to achieving the aim of the Product Roadmap. For example:
+
     * Adding Mandarin translations for an Angular component as part of an internationalization feature
     * Adding payment processing as part of a new subscription feature
 
@@ -38,27 +40,33 @@ To prepare for meetings and maximise the chances of success for your project, en
     ![Figure: Microsoft Viva Goals can link with Azure DevOps to graphically display the progress of Roadmap items](viva-goals-roadmap.png)
 
 3. **Development - What delays or blockers have been encountered while writing the software?** [Software development is painful and costly](/do-you-manage-clients-expectations/). Explain the difficulties that the project has encountered, and detail your plan to overcome those difficulties. For example:
+
     * The upgrade between Angular versions was delayed as the team's Frontend expert has been sick. A new expert has been brought in to complete the work
     * The new customer registration process was taking longer than expected to implement. The intention is to make it simpler with fewer screens
 
 4. **Operations - How do the product's metrics compare historically?** If you have responsibility for the operation of your product, you need to be tracking metrics such as the number of users accessing the system or how many hours they are spending on your site. Provide graphs to demonstrate trends. For example:
+
    * Have a graph demonstrating how the user count has changed over the course of the last 2 calendar years
 
     ![Figure: A graph helps demonstrate trends affecting the Product](user-metrics.png)
 
 5. **Operations - What issues have been seen in Production?** [All errors should be logged](/do-you-log-every-error/), so you should be able to list any significant errors that stakeholders and users have experienced and the plan to prevent those errors in future. You should also be actively monitoring for performance issues. All such issues should have plans for investigation or rectification. For example:
+
     * The frontend has experienced an increase in exceptions when adding new users to the system. This was been tracked to a bug in how data is being serialized from the backend, and was fixed last Sprint
     * Since upgrading the database server version, a significance increase of 2 seconds in server response time has been seen. System Administrators are investigating
 
 6. **Planning - What decisions have been made regarding the project?** As Product Owner, you will be approving changes to the behaviour of the product and many of these changes will be in development. Explain the decisions that you've made and their rationale. Try to catch misalignments in stakeholder views before your decisions are coded. For example:
+
     * I have modified the permissions model for the website to allow contributing users access to unpublished articles, as they often request input from each other
     * I approved the mock-ups for the website redesign, as they were cleaner and easier to understand than the current website pages
 
 7. **Planning - How should the Roadmap be changed to remain relevant?** Circumstances and priorities change - work with your stakeholders to ensure that your product fulfils their requirements while making efficient use of development resources. In extreme cases, the Product Goal itself may need to be revised. For example:
+
     * Users have had significant difficulty writing new articles, as the editing control does not make it easy to link to other articles. Therefore, work should be prioritized to improve how inter-article links are created
     * There has been a significant increase in users, so work needs to be prioritized to improve the throughput of transactions
 
 8. **Resources - do you have everything you need to complete the updated Product Roadmap?** Ensure that you have agreements for funding, personnel or services, or everyone will be unhappy when the Roadmap is inevitably not delivered. For example:
+
     * To implement the article search functionality, approval is required for an increase in funding to cover the Azure Search Service instance
     * To implement the Artificial Intelligence co-writing feature, approval is required to apply for and pay for the Azure OpenAI Service
 

diff --git a/rules/disagreeing-with-powerful-stakeholders/rule.md b/rules/disagreeing-with-powerful-stakeholders/rule.md
@@ -103,7 +103,7 @@ Bad example - The Developer didn't express that it was their opinion.
 :::
 
 :::greybox
-**Product Owner**: \[See above]
+**Product Owner**: [See above]
 
 **Developer**: In my opinion, it's better if we upgrade to .NET 8 this Sprint because it will help fix users' performance issues.
 :::

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
@@ -5,18 +5,18 @@ guid: ddc1af04-cd76-4096-95aa-12626d12491f
 uri: do-you-add-end-screen-to-your-youtube-videos
 created: 2018-07-27T00:10:17.0000000Z
 authors:
-- title: Florent Dezettre
-  url: https://ssw.com.au/people/florent-dezettre
+  - title: Florent Dezettre
+    url: https://ssw.com.au/people/florent-dezettre
 related:
-- personalized-thumbnail
-- sort-videos-into-playlists
-- untapped-keywords
-- videos-youtube-friendly
-- optimize-videos-for-youtube
-- keep-audience-happy
-- youtube-cards
-- do-you-add-time-links-on-your-youtube-videos
-- do-you-follow-image-standard-sizes-on-social-media
+  - personalized-thumbnail
+  - sort-videos-into-playlists
+  - untapped-keywords
+  - videos-youtube-friendly
+  - optimize-videos-for-youtube
+  - keep-audience-happy
+  - youtube-cards
+  - do-you-add-time-links-on-your-youtube-videos
+  - do-you-follow-image-standard-sizes-on-social-media
 redirects: []
 archivedreason: null
 

diff --git a/rules/do-you-create-an-online-itinerary/rule.md b/rules/do-you-create-an-online-itinerary/rule.md
@@ -6,16 +6,16 @@ guid: 66c1fa86-8bea-4638-a4dc-15c3361292e8
 uri: do-you-create-an-online-itinerary
 created: 2015-04-28T05:11:40.0000000Z
 authors:
-- title: Adam Cogan
-  url: https://ssw.com.au/people/adam-cogan
-- title: Joanna Feely
-  url: https://ssw.com.au/people/joanna-feely
+  - title: Adam Cogan
+    url: https://ssw.com.au/people/adam-cogan
+  - title: Joanna Feely
+    url: https://ssw.com.au/people/joanna-feely
 related:
-- do-you-know-the-best-online-accommodation-websites
-- do-you-check-if-your-qantas-flight-is-eligible-for-a-bid-now-upgrade
-- do-you-know-how-to-get-the-most-out-of-your-credit-card
-- do-you-check-your-boarding-pass
-- do-you-take-advantage-of-business-rewards-programs
+  - do-you-know-the-best-online-accommodation-websites
+  - do-you-check-if-your-qantas-flight-is-eligible-for-a-bid-now-upgrade
+  - do-you-know-how-to-get-the-most-out-of-your-credit-card
+  - do-you-check-your-boarding-pass
+  - do-you-take-advantage-of-business-rewards-programs
 redirects: []
 
 ---

diff --git a/rules/document-discoveries/rule.md b/rules/document-discoveries/rule.md
@@ -9,6 +9,8 @@ authors:
     url: https://www.ssw.com.au/people/tylah-kapa
   - title: Piers Sinclair
     url: https://www.ssw.com.au/people/piers-sinclair
+redirects: []
+related: []
 archivedreason: null
 ---
 Work items often have a great description and Acceptance Criteria. However, work can change quickly; sometimes, the justification for those changes ends up in emails or instant messages.

diff --git a/rules/establish-a-Lean-Agile-mindset-across-all-teams/rule.md b/rules/establish-a-Lean-Agile-mindset-across-all-teams/rule.md
@@ -9,9 +9,9 @@ authors:
     url: https://ssw.com.au/people/gert-marx
   - title: Ulysses Maclaren
     url: https://ssw.com.au/people/ulysses-maclaren
-related:
+related: []
 redirects:
- - do-you-establish-a-Lean-Agile-mindset-across-all-teams
+  - do-you-establish-a-Lean-Agile-mindset-across-all-teams
 archivedreason: null
 ---
 In any bustling organization, it's common to see multiple teams working at their own pace, each with its distinct flavor of 'agility'. But what happens when some of those flavors are a tad outdated? The result: a mix of inefficiencies, delays, and missed beats.

diff --git a/rules/find-your-license/rule.md b/rules/find-your-license/rule.md
@@ -46,6 +46,7 @@ As per GitHub's [documentation](https://docs.github.com/en/repositories/managing
 The [MIT License](https://choosealicense.com/licenses/mit/) is a well known license trusted by many open-source projects.
 
 Examples include:
+
 * [Dotnet](https://github.com/dotnet/runtime/blob/main/LICENSE.TXT)
 * [Ruby on Rails](https://github.com/rails/rails/blob/main/MIT-LICENSE)
 
@@ -65,6 +66,7 @@ Examples include:
 A copyleft license like the [Gnu Public License](https://choosealicense.com/licenses/gpl-3.0/) promote and protect the principals of open-source software. Though they may also introduce complexities and potential limitations that users may be deterred by.
 
 Examples include:
+
 * [Ansible](https://github.com/ansible/ansible/blob/devel/COPYING)
 * [Bash](https://git.savannah.gnu.org/cgit/bash.git/tree/COPYING)
 
@@ -83,6 +85,7 @@ Examples include:
 Companies often use a proprietary license when they prefer to have fine-grained control over their intellectual property.
 
 Examples include:
+
 * [Mozilla](https://www.mozilla.org/en-US/MPL/)
 * [Duende](https://duendesoftware.com/license)
 
@@ -101,6 +104,7 @@ Examples include:
 Sentry introduced the [FSL](https://fsl.software/) as a way to support the open-source community whilst retaining control over their IP.
 
 Examples of projects with this license include:
+
 * [Sentry](https://github.com/getsentry/self-hosted/blob/master/LICENSE.md)
 * [GitButler](https://github.com/gitbutlerapp/gitbutler/blob/master/LICENSE.md)
 

diff --git a/rules/implement-business-logic-in-middle-tier/rule.md b/rules/implement-business-logic-in-middle-tier/rule.md
@@ -6,11 +6,11 @@ guid: 66e5d862-74c1-440d-89df-3c27ab1d0485
 uri: implement-business-logic-in-middle-tier
 created: 2019-11-14T22:30:36.0000000Z
 authors:
-- title: Adam Cogan
-  url: https://ssw.com.au/people/adam-cogan
+  - title: Adam Cogan
+    url: https://ssw.com.au/people/adam-cogan
 related: []
 redirects:
-- middle-tier-do-you-implement-business-logic-in-middle-tier
+  - middle-tier-do-you-implement-business-logic-in-middle-tier
 
 ---
 

diff --git a/rules/monitor-seo-effectively/rule.md b/rules/monitor-seo-effectively/rule.md
@@ -40,7 +40,7 @@ SEO means working with a large amount of data. A single website can have even up
 
 #### SEMrush
 
-[SEMrush](semrush.com) connects to Google Analytics and provides an informative and customizable user interface for understanding a website's data. It helps show how a site ranks on Google, what keywords to use, comparisons to competitors and more. Its goal is to help improve online visibility and marketing strategies.
+[SEMrush](https://semrush.com) connects to Google Analytics and provides an informative and customizable user interface for understanding a website's data. It helps show how a site ranks on Google, what keywords to use, comparisons to competitors and more. Its goal is to help improve online visibility and marketing strategies.
 
 ![Figure: SEMrush dashboard shows information we can use to improve our website](semrush1.jpg)
 

diff --git a/rules/prioritise-value-streams-over-individual-projects/rule.md b/rules/prioritise-value-streams-over-individual-projects/rule.md
@@ -11,7 +11,7 @@ authors:
     url: https://ssw.com.au/people/ulysses-maclaren
 related:
 redirects: 
- - do-you-prioritise-value-streams-over-individual-projects
+  - do-you-prioritise-value-streams-over-individual-projects
 archivedreason: null
 ---
 Imagine managing a bunch of projects, each with its own goals and deadlines. It's easy to get caught up in the details and miss the bigger picture. Sometimes, even though every project seems super important, they might not all line up with what the business really needs. That's when you realize: it's all about focusing on value streams, not just individual projects.

diff --git a/rules/scrum-should-be-capitalized/rule.md b/rules/scrum-should-be-capitalized/rule.md
@@ -1,17 +1,18 @@
 ---
 type: rule
-archivedreason: 
-title: Do you know "Scrum" (and other Scrum terms) should be capitalized?
+archivedreason: null
+title: | 
+  Do you know "Scrum" (and other Scrum terms) should be capitalized?
 guid: b0fdd7d0-664d-44ea-8cf8-7773c15becf4
 uri: scrum-should-be-capitalized
 created: 2020-03-11T00:28:43.0000000Z
 authors:
-- title: Adam Cogan
-  url: https://ssw.com.au/people/adam-cogan
+  - title: Adam Cogan
+    url: https://ssw.com.au/people/adam-cogan
 related:
-- use-the-right-capitalization
+  - use-the-right-capitalization
 redirects:
-- tiny-do-you-know-scrum-should-be-capitalized
+  - tiny-do-you-know-scrum-should-be-capitalized
 
 ---
 

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
@@ -6,15 +6,15 @@ guid: 3d0d413a-403c-4cde-b879-a485cf2fefea
 uri: take-care-of-your-personal-presentation-for-remote-meetings
 created: 2020-03-25T03:16:15.0000000Z
 authors:
-- title: Adam Cogan
-  url: https://ssw.com.au/people/adam-cogan
-- title: Camilla Rosa Silva
-  url: https://ssw.com.au/people/camilla-rosa-silva
-- title: Steven Andrews
-  url: https://ssw.com.au/people/steven-andrews
+  - title: Adam Cogan
+    url: https://ssw.com.au/people/adam-cogan
+  - title: Camilla Rosa Silva
+    url: https://ssw.com.au/people/camilla-rosa-silva
+  - title: Steven Andrews
+    url: https://ssw.com.au/people/steven-andrews
 related: []
 redirects:
-- do-you-take-care-of-your-personal-appearance-even-for-remote-meetings
+  - do-you-take-care-of-your-personal-appearance-even-for-remote-meetings
 
 ---
 

diff --git a/rules/ticks-crosses/rule.md b/rules/ticks-crosses/rule.md
@@ -79,7 +79,7 @@ Standarding your ticks and crosses using a lower third helps the team have a con
 ![Figure: Good example - The red cross and bad example in the lower third + subtle sound - 0:58 - 1:07](rules/ticks-crosses/Do you ask for small content changes using from X to Y.png)
 :::
 
----
+----
 
 ::: greybox
 

diff --git a/rules/use-net-maui/rule.md b/rules/use-net-maui/rule.md
@@ -1,6 +1,7 @@
 ---
 type: rule
-title: Do you use .NET MAUI (was Xamarin)?
+title: | 
+  Do you use .NET MAUI (was Xamarin)?
 uri: use-net-maui
 authors:
   - title: Adam Cogan
@@ -12,8 +13,9 @@ redirects:
   - do-you-use-xamarin-forms
   - use-xamarin-forms
 created: 2020-10-05T22:18:32.000Z
-archivedreason: Replaced by [https://www.ssw.com.au/rules/build-cross-platform-apps](/rules/build-cross-platform-apps)
 guid: 954d9b68-7185-472b-917c-407aa1a7df26
+archivedreason: | 
+  Replaced by [https://www.ssw.com.au/rules/build-cross-platform-apps](/rules/build-cross-platform-apps)
 ---
 Xamarin has evolved beyond simply being an abstraction of the platform native APIs for iOS, Android, and UWP. It is now the .NET Multi-platform App UI (.NET MAUI).
 

diff --git a/rules/use-the-right-capitalization/rule.md b/rules/use-the-right-capitalization/rule.md
@@ -6,13 +6,13 @@ guid: ba19431b-408b-4a8a-806e-9f296458ba2b
 uri: use-the-right-capitalization
 created: 2016-04-21T07:37:05.0000000Z
 authors:
-- title: Joanna Feely
-  url: https://ssw.com.au/people/joanna-feely
+  - title: Joanna Feely
+    url: https://ssw.com.au/people/joanna-feely
 related:
-- how-to-capitalize-titles
-- scrum-should-be-capitalized
+  - how-to-capitalize-titles
+  - scrum-should-be-capitalized
 redirects:
-- do-you-know-to-capitalize-tech-terms-correctly
+  - do-you-know-to-capitalize-tech-terms-correctly
 
 ---
 

diff --git a/rules/write-a-good-pull-request/rule.md b/rules/write-a-good-pull-request/rule.md
@@ -143,6 +143,7 @@ There is also well-known Pull Request semantics like [Conventional Commits](http
 ### How to approach making a Pull Request
 
 `youtube: https://www.youtube.com/watch?v=d8yGY6KsYys&t=29s`
+
 **Video: 5 Tips For Better Pull Requests (11 min)**
 
 #### FAQs