Broke a lot of diagrams

risk-first · Jun 12, 2024 · 6a1c48c · 6a1c48c
1 parent abaf591
commit 6a1c48c
Show file tree

Hide file tree

Showing 361 changed files with 148,119 additions and 30,542 deletions.
diff --git a/docs/practices/Communication-And-Collaboration/Demo.md b/docs/practices/Communication-And-Collaboration/Demo.md
@@ -22,8 +22,6 @@ practice:
    - tag: Learning Curve Risk
      reason: "Prototypes are a way of learning about a particular solution to a problem."
   attendant:
-   - tag: Complexity Risk
-     reason: "Creating demos can add complexity and require additional resources."
    - tag: Schedule Risk
      reason: "Demos can introduce delays if not planned and executed properly."
   related:

diff --git a/docs/practices/Communication-And-Collaboration/Documentation.md b/docs/practices/Communication-And-Collaboration/Documentation.md
@@ -24,6 +24,8 @@ practice:
      reason: "Creating and maintaining documentation can be time-consuming."
    - tag: Complexity Risk
      reason: "Extensive documentation can sometimes add to complexity rather than simplifying it."
+   - tag: Implementation Risk
+     reason: "Poorly documentation can lead to implementation issues in development."
   related:
    - ../Planning-and-Management/Requirements-Capture
    - ../Development-and-Coding/Code-Reviews

diff --git a/docs/practices/Communication-And-Collaboration/Review.md b/docs/practices/Communication-And-Collaboration/Review.md
@@ -22,6 +22,8 @@ practice:
      reason: "Identifies and resolves potential complexities during the review process."
    - tag: Agency Risk
      reason: "Reviewing work or activity can ensure good behaviour."
+   - tag: Map And Territory Risk
+     reason: "Reviews and audits can uncover unseen problems in a system"
   attendant:
    - tag: Schedule Risk
      reason: "Reviews can introduce delays in the project timeline."

diff --git a/docs/practices/Communication-And-Collaboration/Training.md b/docs/practices/Communication-And-Collaboration/Training.md
@@ -24,8 +24,6 @@ practice:
      reason: "Training sessions can take time away from development, impacting schedules."
    - tag: Dependency Risk
      reason: "Creates a dependency on training programs and their effectiveness."
-   - tag: Implementation Risk
-     reason: "Poorly implemented training programs can lead to inadequate skill development."
   related:
    - ../Documentation
    - ../Development-and-Coding/Pair-Programming

diff --git a/docs/practices/Deployment-And-Operations/Automation.md b/docs/practices/Deployment-And-Operations/Automation.md
@@ -34,6 +34,8 @@ practice:
      reason: Automated processes have their own agency and might not work as desired.
    - tag: Security Risk
      reason: Automation can introduce security issues if automated processes are given elevated privileges.  
+   - tag: Map And Territory Risk
+     reason: "Automation of reporting and status can hide the truth of a system's health."
   related:
    - ../Development-And-Coding/Coding
    - ../Tools-And-Standards/Measurement

diff --git a/docs/practices/Deployment-And-Operations/Incident-Management.md b/docs/practices/Deployment-And-Operations/Incident-Management.md
diff --git a/docs/practices/Deployment-And-Operations/Release-Delivery.md b/docs/practices/Deployment-And-Operations/Release-Delivery.md
@@ -21,8 +21,6 @@ practice:
    - tag: Funding Risk
      reason: "Delivering features might mean you get paid for the software you write."
   attendant:
-   - tag: Complexity Risk
-     reason: "Release processes can add complexity to project management."
    - tag: Schedule Risk
      reason: "Delays in the release process can impact overall project timelines."
    - tag: Operational Risk

diff --git a/docs/practices/Development-And-Coding/Coding.md b/docs/practices/Development-And-Coding/Coding.md
@@ -21,7 +21,7 @@ practice:
    - tag: Implementation Risk
      reason: "Poor coding practices can lead to significant implementation issues."
    - tag: Complexity Risk
-     reason: "Complex code can be difficult to maintain and understand."
+     reason: "Writing new code adds complexity to a project."
    - tag: Regression Risk
      reason: "Changes in code can introduce new bugs and regressions."
   related:

diff --git a/docs/practices/Development-And-Coding/Debugging.md b/docs/practices/Development-And-Coding/Debugging.md
@@ -22,8 +22,6 @@ practice:
   attendant:
    - tag: Schedule Risk
      reason: "Debugging can be time-consuming, affecting project timelines."
-   - tag: Complexity Risk
-     reason: "Complex bugs can be challenging and resource-intensive to resolve."
    - tag: Dependency Risk
      reason: "Debugging may reveal dependencies on other systems or components."
   related:

diff --git a/docs/practices/Development-And-Coding/Version-Control.md b/docs/practices/Development-And-Coding/Version-Control.md
@@ -19,11 +19,6 @@ practice:
      reason: "Facilitates collaboration by allowing multiple developers to work on the codebase simultaneously."
    - tag: Regression Risk
      reason: "Maintains a history of changes, allowing rollback to previous versions if needed."
-  attendant:
-   - tag: Complexity Risk
-     reason: "Managing branches and merges can add complexity."
-   - tag: Security Risk
-     reason: "Requires proper access control to prevent unauthorized changes."
   related:
    - ../Planning-and-Management/Change-Management
    - ../Development-and-Coding/Coding

diff --git a/.../Planning-And-Management/Issue-Logging.md → ...anning-And-Management/Issue-Management.md b/.../Planning-And-Management/Issue-Logging.md → ...anning-And-Management/Issue-Management.md
@@ -1,5 +1,5 @@
 ---
-title: Issue Logging
+title: Issue Management
 description: Logging support issues and tracking their resolution.
 tags: 
   - Issue Logging
@@ -21,6 +21,8 @@ practice:
      reason: "Facilitates communication about issues and their status among team members."
    - tag: Trust and Belief Risk
      reason: "Tracking and fixing bugs improves software reputation."
+   - tag: Security Risk
+     reason: "Addresses and resolves security incidents to protect the organization."
   attendant:
    - tag: Complexity Risk
      reason: "Managing a large number of logged issues can add complexity."
@@ -38,4 +40,9 @@ practice:
 
 ## Description
 
+> "Issue tracking systems are used to manage and maintain lists of issues, as needed by an organization." - [Issue tracking system, _Wikipedia_](https://en.wikipedia.org/wiki/Issue_tracking_system)
+
+Issue Management / Issue Logging in software development involves recording and tracking issues, bugs, and tasks. This practice helps in managing and resolving defects systematically, ensuring that all problems are addressed in a timely manner and improving the overall quality of the software.
+
+
 > "Issue
diff --git a/docs/practices/Planning-And-Management/Prioritising.md b/docs/practices/Planning-And-Management/Prioritising.md
@@ -23,8 +23,6 @@ practice:
   attendant:
    - tag: Scarcity Risk
      reason: "Prioritization can create dependencies on specific tasks or features."
-   - tag: Complexity Risk
-     reason: "Sometimes prioritising in the wrong order can create project complexity."
   related:
    - ../Planning-and-Management/Requirements-Capture
    - ../Communication-and-Collaboration/Retrospectives

diff --git a/docs/practices/Testing-and-Quality-Assurance/Integration-Testing.md b/docs/practices/Testing-and-Quality-Assurance/Integration-Testing.md
@@ -24,8 +24,6 @@ practice:
      reason: "Can be time-consuming, leading to delays in the project timeline."
    - tag: Software Dependency Risk
      reason: "Adds dependencies on test environments and their availability."
-   - tag: Complexity Risk
-     reason: "Integrating multiple components can be complex work in itself."
   related:
    - ../Planning-and-Management/Change-Management
    - ../Development-and-Coding/Unit-Testing

diff --git a/docs/practices/Testing-and-Quality-Assurance/Measurement.md b/docs/practices/Testing-and-Quality-Assurance/Measurement.md
@@ -26,6 +26,8 @@ practice:
      reason: "Creates dependencies on measurement tools and their accuracy."
    - tag: Complexity Risk
      reason: "Collecting and analyzing data can add to the complexity of the project."
+   - tag: Map And Territory Risk
+     reason: "Focusing on the wrong measures can blind you to what's important."
   related:
    - ../Deployment-and-Operations/Monitoring
    - ../Planning-and-Management/Estimation

diff --git a/docs/practices/Testing-and-Quality-Assurance/Performance-Testing.md b/docs/practices/Testing-and-Quality-Assurance/Performance-Testing.md
@@ -22,6 +22,8 @@ practice:
      reason: "Requires sophisticated tools and setup, adding complexity."
    - tag: Funding Risk
      reason: "Performance testing tools and environments can be expensive."
+   - tag: Map And Territory Risk
+     reason: "Performance testing might not be reflecting real-world scenarios."
   related:
    - ../Development-and-Coding/Coding
    - ../Testing-and-Quality-Assurance/Integration-Testing

diff --git a/docs/practices/Testing-and-Quality-Assurance/Unit-Testing.md b/docs/practices/Testing-and-Quality-Assurance/Unit-Testing.md
@@ -26,6 +26,8 @@ practice:
      reason: "Managing a large suite of unit tests can add to the complexity."
    - tag: Software Dependency Risk
      reason: "Creates dependencies on testing frameworks and tools."
+   - tag: Map And Territory Risk
+     reason: "Unit Testing and code coverage doesn't reflect how a system will work when assembled."
   related:
    - ../Testing-and-Quality-Assurance/Integration-Testing
    - ../Development-and-Coding/Coding

diff --git a/docs/practices/todo.txt b/docs/practices/todo.txt
@@ -11,4 +11,6 @@ Looking for balance:
 grep -R " - tag:" docs/practices | sed 's/.*://' | sort | uniq -c
 
 
-Pressure?
+Pressure
+
+FIX LINKS
diff --git a/docs/risks/A-Pattern-Language.md b/docs/risks/A-Pattern-Language.md
@@ -4,7 +4,7 @@ description: Explanation of how Risk-First comprises a pattern language of risk
 url: https://riskfirst.org/risks/A-Pattern-Language
 
 featured: 
-  class: bg2
+  class: c
   element: '<protocol-artifact>Patterns</protocol-artifact>'
 tags: 
  - Risks

diff --git a/docs/risks/Communication-Risks/Communication-Risk.md b/docs/risks/Communication-Risks/Communication-Risk.md
@@ -1,5 +1,5 @@
 ---
-title: Communication Risks
+title: Communication Risk
 description: Why is it so hard to be understood?
 
 featured: 
@@ -21,6 +21,9 @@ redirect_from:
 tweet: yes
 ---
 
+<RiskIntro fm={frontMatter} />
+
+
 # Communication Risk
 
 If we all had identical knowledge, there would be no need to do any communicating at all, and therefore no [Communication Risk](Communication-Risk.md).  

diff --git a/docs/risks/Complexity-Risk.md b/docs/risks/Complexity-Risk.md
@@ -4,7 +4,7 @@ description: A lot of advice around constructing software comes back to simplici
 url: https://riskfirst.org/risks/Complexity-Risk
 
 featured: 
-  class: bg2
+  class: c
   element: '<risk class="complexity" />'
 sidebar_position: 5
 tags:
@@ -18,7 +18,7 @@ redirect_from:
  - /Complexity-Risk
 ---
 
-# Complexity Risk
+<RiskIntro fm={frontMatter} />
 
 [Complexity Risk](Complexity-Risk.md) is the [risk](../thinking/Glossary.md#risk) to your project due to its underlying "complexity".   Here, we will break down exactly what we mean by complexity, look at where it can hide on a software project and discuss some ways in which we can manage this important risk.
 

diff --git a/docs/risks/Coordination-Risk.md b/docs/risks/Coordination-Risk.md
@@ -4,7 +4,7 @@ description: What prevents us working as a team?  Why are distributed systems so
 url: https://riskfirst.org/risks/Coordination-Risk
 
 featured: 
-  class: bg2
+  class: c
   element: '<risk class="coordination" />'
 sidebar_position: 13
 tags:
@@ -15,7 +15,7 @@ redirect_from:
 tweet: yes
 ---
 
-# Coordination Risk
+<RiskIntro fm={frontMatter} />
 
 As in [Agency Risk](Agency-Risk.md), we are going to use the term _agent_, which refers to anything with [agency](Agency-Risk.md#software-processes) in a system to make decisions:  that is, an agent has an [Internal Model](../thinking/Glossary.md#internal-model) and can [take actions](../thinking/Glossary.md#taking-action) based on it.  Here, we work on the assumption that the agents _are_ working towards a common [Goal](../thinking/Glossary.md#goal), even though in reality it's not always the case, as we saw in the section on [Agency Risk](Agency-Risk.md).
 

diff --git a/docs/risks/Dependency-Risks/Agency-Risk.md b/docs/risks/Dependency-Risks/Agency-Risk.md
@@ -8,15 +8,15 @@ tags:
  - Goal
  - Agency Risk
 featured: 
-  class: bg2
+  class: c
   element: '<risk class="agency" />'
 sidebar_position: 12
 redirect_from: 
  - /Agency-Risk
 tweet: yes
 ---
 
-# Agency Risk
+<RiskIntro fm={frontMatter} />
 
 Coordinating a team is difficult enough when everyone on the team has a single [Goal](../thinking/Glossary.md#goal).  But people have their own goals too.  Sometimes their goals harmlessly co-exist with the team's goal, other times they don't. 
 

diff --git a/docs/risks/Dependency-Risks/Boundary-Risk.md b/docs/risks/Dependency-Risks/Boundary-Risk.md
@@ -4,7 +4,7 @@ description: On avoiding mistakes that limit your options later on.
 url: https://riskfirst.org/risks/Boundary-Risk
 
 featured: 
-  class: bg2
+  class: c
   element: '<risk class="boundary" />'
 sidebar_position: 11
 tags:
@@ -15,7 +15,7 @@ redirect_from:
 tweet: yes
 ---
 
-# Boundary Risk
+<RiskIntro fm={frontMatter} />
 
 In the previous sections on [Dependency Risk](Dependency-Risk.md) we've touched on [Boundary Risk](Boundary-Risk.md) several times, but now it's time to tackle it head-on and discuss this important type of risk.  
 

diff --git a/docs/risks/Dependency-Risks/Deadline-Risk.md b/docs/risks/Dependency-Risks/Deadline-Risk.md
@@ -4,7 +4,7 @@ description: What is the point of a deadline?  Do they serve a useful purpose?
 url: https://riskfirst.org/risks/Deadline-Risk
 
 featured: 
-  class: bg2
+  class: c
   element: '<risk class="deadline" />'
 sidebar_position: 8
 tags:
@@ -15,7 +15,7 @@ redirect_from:
 tweet: yes
 ---
 
-# Deadline Risk
+<RiskIntro fm={frontMatter} />
 
 Let's examine dependencies on _events_.  
 

diff --git a/docs/risks/Dependency-Risks/Dependency-Risk.md b/docs/risks/Dependency-Risks/Dependency-Risk.md
@@ -3,7 +3,7 @@ title: Dependency Risks
 description: Risks faced by depending on something else,  e.g. an event, process, person, piece of software or an organisation. 
 url: https://riskfirst.org/risks/Dependency-Risk
 featured: 
-  class: bg2
+  class: c
   element: '<risk class="dependency" />'
 sidebar_position: 6
 tags:

diff --git a/docs/risks/Dependency-Risks/Process-Risk.md b/docs/risks/Dependency-Risks/Process-Risk.md
@@ -4,7 +4,7 @@ description: Risks due to the following a particular protocol of communication w
 url: https://riskfirst.org/risks/Process-Risk
 
 featured: 
-  class: bg2
+  class: c
   element: '<risk class="process" />'
 sidebar_position: 10
 redirect_from: 
@@ -15,7 +15,7 @@ tags:
  - Process Risk
 ---
 
-# Process Risk
+<RiskIntro fm={frontMatter} />
 
 [Process Risk](Process-Risk.md) is the risk you take on whenever you embark on completing a _process_. <!-- tweet-end -->
 

diff --git a/docs/risks/Dependency-Risks/Reliability-Risk.md b/docs/risks/Dependency-Risks/Reliability-Risk.md
@@ -4,7 +4,7 @@ description: Risks of not getting benefit from a dependency due to it's reliabil
 url: https://riskfirst.org/risks/Reliability-Risk
 
 featured: 
-  class: bg2
+  class: c
   element: '<risk class="dependency" />'
 sidebar_position: 6
 tags:
@@ -18,8 +18,7 @@ redirect_from:
 tweet: yes
 ---
 
-
-## Reliability Risk
+<RiskIntro fm={frontMatter} />
 
 This points to the problem that when we use an external dependency, we are at the mercy of its reliability.   
 

diff --git a/docs/risks/Dependency-Risks/Scarcity-Risk.md b/docs/risks/Dependency-Risks/Scarcity-Risk.md
@@ -4,7 +4,7 @@ description: Scarcity Risk is about quantities of a dependency, and specifically
 url: https://riskfirst.org/risks/Scarcity-Risk
 
 featured: 
-  class: bg2
+  class: c
   element: '<risk class="scarcity" />'
 sidebar_position: 7
 redirect_from: 
@@ -18,7 +18,7 @@ tags:
  - Schedule Risk
 ---
 
-# Scarcity Risk
+<RiskIntro fm={frontMatter} />
 
 While [Reliability Risk](Dependency-Risk.md#reliability-risk) (which we met in the previous section) considers what happens when a _single dependency_ is unreliable, scarcity is about _quantities_ of a dependency, and specifically, _not having enough_.  <!-- tweet-end -->