Skip to content

Commit da57e16

Browse files
committed
docs: standardize multi-line text formatting in diagrams and tables by replacing HTML line breaks with hyphens.
1 parent 604b380 commit da57e16

12 files changed

Lines changed: 97 additions & 99 deletions

File tree

01-curriculum/01-requirements-engineering.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ Think of requirements as a pyramid - each level builds on the foundation below:
4040

4141
```mermaid
4242
graph TD
43-
A[Business Requirements<br/>"Why are we building this?"] --> B[User Requirements<br/>"What do users need?"]
44-
B --> C[Functional Requirements<br/>"What should it do?"]
45-
C --> D[Non-Functional Requirements<br/>"How well should it do it?"]
43+
A[Business Requirements - Why are we building this] --> B[User Requirements - What do users need]
44+
B --> C[Functional Requirements - What should it do]
45+
C --> D[Non-Functional Requirements - How well should it do it]
4646
4747
style A fill:#e1f5ff
4848
style B fill:#fff4e1

01-curriculum/03-strategy-analysis.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ graph TB
6666

6767
| Block | Description |
6868
| -------------------------- | --------------------------------------------------------------------------------------------- |
69-
| **Customer Segments** | 1) Diners (urban professionals, 25-45) <br/> 2) Restaurants (casual dining, 20-100 seats) |
70-
| **Value Propositions** | Diners: Book in 60 sec, guaranteed seating <br/> Restaurants: Reduce no-shows from 30% to <5% |
69+
| **Customer Segments** | 1) Diners (urban professionals, 25-45) - 2) Restaurants (casual dining, 20-100 seats) |
70+
| **Value Propositions** | Diners: Book in 60 sec, guaranteed seating - Restaurants: Reduce no-shows from 30% to <5% |
7171
| **Channels** | Web app (mobile-responsive), restaurant partner outreach, social media ads |
7272
| **Customer Relationships** | Self-service platform, automated SMS, dedicated restaurant success team |
7373
| **Revenue Streams** | 10% commission on completed bookings |
@@ -104,7 +104,7 @@ Analyzes industry attractiveness and competitive intensity.
104104

105105
```mermaid
106106
mindmap
107-
root((Restaurant<br/>Reservation<br/>Market))
107+
root((Restaurant - Reservation - Market))
108108
Threat of New Entrants
109109
Low barriers technical
110110
High barriers network effects
@@ -217,7 +217,7 @@ sequenceDiagram
217217
Diner->>Host: Provide name & phone
218218
Host->>Paper Book: Write booking
219219
Host->>Diner: "See you then!" (verbal only)
220-
Note over Diner: No confirmation<br/>Anxiety!
220+
Note over Diner: No confirmation - Anxiety!
221221
```
222222

223223
**Pain Points:**
@@ -251,7 +251,7 @@ sequenceDiagram
251251
SMS Gateway-->>Diner: SMS within 30 sec
252252
App->>Restaurant Dashboard: New booking notification
253253
App-->>Diner: Confirmation page
254-
Note over Diner: Peace of mind!<br/>Proof of booking
254+
Note over Diner: Peace of mind! - Proof of booking
255255
```
256256

257257
**Improvements:**

01-curriculum/04-data-analytics.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,10 @@ Also called **Pirate Metrics** (AARRR = "Arrr!"). Tracks users through 5 stages:
9191

9292
```mermaid
9393
graph LR
94-
A[Acquisition<br/>How users find you] --> B[Activation<br/>First good experience]
95-
B --> C[Retention<br/>Come back]
96-
C --> D[Revenue<br/>Pay us]
97-
D --> E[Referral<br/>Tell others]
94+
A[Acquisition - How users find you] --> B[Activation - First good experience]
95+
B --> C[Retention - Come back]
96+
C --> D[Revenue - Pay us]
97+
D --> E[Referral - Tell others]
9898
9999
style A fill:#e1f5ff
100100
style B fill:#fff4e1
@@ -321,8 +321,8 @@ ORDER BY bookings DESC;
321321

322322
```mermaid
323323
graph LR
324-
A[users table<br/>user_id, name, email] ---|user_id| B[bookings table<br/>booking_id, user_id, restaurant_id]
325-
B ---|restaurant_id| C[restaurants table<br/>restaurant_id, name, cuisine]
324+
A[users table - user_id, name, email] ---|user_id| B[bookings table - booking_id, user_id, restaurant_id]
325+
B ---|restaurant_id| C[restaurants table - restaurant_id, name, cuisine]
326326
```
327327

328328
```sql

01-curriculum/05-product-process.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ Learn the **ceremonies, artifacts, and rhythms** of modern product teams. This m
4646

4747
```mermaid
4848
graph LR
49-
A[Sprint Planning<br/>4 hours] --> B[Daily Standups<br/>15 min/day]
50-
B --> C[Development Work<br/>10 working days]
51-
C --> D[Sprint Review<br/>2 hours]
52-
D --> E[Sprint Retro<br/>1.5 hours]
49+
A[Sprint Planning - 4 hours] --> B[Daily Standups - 15 min/day]
50+
B --> C[Development Work - 10 working days]
51+
C --> D[Sprint Review - 2 hours]
52+
D --> E[Sprint Retro - 1.5 hours]
5353
E --> A
5454
5555
style A fill:#e1f5ff

01-curriculum/06-quality-assurance.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ Quality isn't just QA's job - it's everyone's responsibility. This module teache
3434

3535
```mermaid
3636
graph TD
37-
A[Manual/Exploratory<br/>5% of tests] --> B[UI/E2E Tests<br/>15% of tests]
38-
B --> C[Integration Tests<br/>30% of tests]
39-
C --> D[Unit Tests<br/>50% of tests]
37+
A[Manual/Exploratory - 5% of tests] --> B[UI/E2E Tests - 15% of tests]
38+
B --> C[Integration Tests - 30% of tests]
39+
C --> D[Unit Tests - 50% of tests]
4040
4141
style A fill:#ff6b6b
4242
style B fill:#ffd93d

01-curriculum/07-technical-fluency.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -561,9 +561,9 @@ sequenceDiagram
561561
participant Twilio as SMS Gateway (Twilio)
562562
participant User as Customer's Phone
563563
564-
App->>Twilio: POST /sms/send<br/>{to: "+1-555-123", message: "Booking confirmed"}
564+
App->>Twilio: POST /sms/send - {to: "+1-555-123", message: "Booking confirmed"}
565565
Twilio->>User: SMS delivered
566-
Twilio->>App: POST /webhooks/sms-status<br/>{status: "delivered", message_id: "SM123"}
566+
Twilio->>App: POST /webhooks/sms-status - {status: "delivered", message_id: "SM123"}
567567
App->>App: Update booking record: sms_delivered = true
568568
```
569569

02-reserve-easy-project/01-discovery/opportunity-tree.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,22 +25,22 @@ Desired Outcome (North Star)
2525

2626
```mermaid
2727
graph TD
28-
Outcome[Desired Outcome:<br/>Maximize completed bookings<br/>Revenue per restaurant]
28+
Outcome[Desired Outcome: - Maximize completed bookings - Revenue per restaurant]
2929
30-
Outcome --> Opp1[Opportunity 1:<br/>Diners abandon booking flow<br/>20% drop-off]
31-
Outcome --> Opp2[Opportunity 2:<br/>Restaurants lose revenue to no-shows<br/>30% no-show rate]
32-
Outcome --> Opp3[Opportunity 3:<br/>Booking modifications are difficult<br/>15% cancellation rate]
30+
Outcome --> Opp1[Opportunity 1: - Diners abandon booking flow - 20% drop-off]
31+
Outcome --> Opp2[Opportunity 2: - Restaurants lose revenue to no-shows - 30% no-show rate]
32+
Outcome --> Opp3[Opportunity 3: - Booking modifications are difficult - 15% cancellation rate]
3333
34-
Opp1 --> Sol1A[Solution: 60-second booking flow<br/>Pre-filled forms for returning users]
35-
Opp1 --> Sol1B[Solution: Guest checkout<br/>No account required]
36-
Opp1 --> Sol1C[Solution: Apple Pay / Google Pay<br/>One-tap payment]
34+
Opp1 --> Sol1A[Solution: 60-second booking flow - Pre-filled forms for returning users]
35+
Opp1 --> Sol1B[Solution: Guest checkout - No account required]
36+
Opp1 --> Sol1C[Solution: Apple Pay / Google Pay - One-tap payment]
3737
38-
Opp2 --> Sol2A[Solution: Deposit system<br/>$10/person for parties 6+]
39-
Opp2 --> Sol2B[Solution: 24-hour SMS reminder<br/>Reduce forgetfulness]
40-
Opp2 --> Sol2C[Solution: Easy cancellation<br/>Free up tables for walk-ins]
38+
Opp2 --> Sol2A[Solution: Deposit system - $10/person for parties 6+]
39+
Opp2 --> Sol2B[Solution: 24-hour SMS reminder - Reduce forgetfulness]
40+
Opp2 --> Sol2C[Solution: Easy cancellation - Free up tables for walk-ins]
4141
42-
Opp3 --> Sol3A[Solution: Self-serve modification<br/>Change time/party size in app]
43-
Opp3 --> Sol3B[Solution: Flexible cancellation policy<br/>Full refund if >24 hours notice]
42+
Opp3 --> Sol3A[Solution: Self-serve modification - Change time/party size in app]
43+
Opp3 --> Sol3B[Solution: Flexible cancellation policy - Full refund if >24 hours notice]
4444
4545
style Outcome fill:#e1f5ff,stroke:#0066cc,stroke-width:3px
4646
style Opp1 fill:#fff4e1,stroke:#ff9900,stroke-width:2px

02-reserve-easy-project/03-design/process-maps.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ sequenceDiagram
3636
D->>H: Provide name & phone number
3737
H->>B: Write booking manually
3838
H->>D: "See you then!" (verbal only)
39-
Note over D: No confirmation<br/>Anxiety!
39+
Note over D: No confirmation - Anxiety!
4040
else Table Not Available
4141
H->>D: "Sorry, fully booked"
4242
D->>P: Call next restaurant
@@ -93,9 +93,9 @@ sequenceDiagram
9393
RD-->>RD: New booking alert
9494
end
9595
96-
A-->>D: Confirmation page<br/>Code: ABC123
96+
A-->>D: Confirmation page - Code: ABC123
9797
98-
Note over D: Instant proof of booking<br/>Peace of mind!
98+
Note over D: Instant proof of booking - Peace of mind!
9999
```
100100

101101
**Improvements:**
@@ -113,27 +113,27 @@ sequenceDiagram
113113

114114
```mermaid
115115
flowchart TD
116-
Start([Diner clicks<br/>'Cancel Reservation']) --> Check{When is<br/>the booking?}
116+
Start([Diner clicks Cancel Reservation]) --> Check{When is the booking?}
117117
118-
Check -->|> 24 hours| FullRefund[Full refund<br/>if deposit paid]
119-
Check -->|2-24 hours| PartialRefund[50% refund<br/>if deposit paid]
118+
Check -->|> 24 hours| FullRefund[Full refund - if deposit paid]
119+
Check -->|2-24 hours| PartialRefund[50% refund - if deposit paid]
120120
Check -->|< 2 hours| NoRefund[No refund]
121121
122-
FullRefund --> UpdateDB[Update booking<br/>status = 'cancelled']
122+
FullRefund --> UpdateDB[Update booking status to cancelled]
123123
PartialRefund --> UpdateDB
124124
NoRefund --> UpdateDB
125125
126-
UpdateDB --> SendSMS[Send SMS<br/>'Cancellation confirmed']
127-
SendSMS --> NotifyRestaurant[Notify restaurant<br/>via dashboard]
126+
UpdateDB --> SendSMS[Send SMS Cancellation confirmed]
127+
SendSMS --> NotifyRestaurant[Notify restaurant - via dashboard]
128128
129-
FullRefund --> ProcessRefund{Deposit<br/>paid?}
129+
FullRefund --> ProcessRefund{Deposit - paid?}
130130
PartialRefund --> ProcessRefund
131131
NoRefund --> ProcessRefund
132132
133-
ProcessRefund -->|Yes| InitiateRefund[Stripe refund API<br/>3-5 business days]
133+
ProcessRefund -->|Yes| InitiateRefund[Stripe refund API - 3-5 business days]
134134
ProcessRefund -->|No| Skip[Skip refund]
135135
136-
InitiateRefund --> End([Cancellation<br/>complete])
136+
InitiateRefund --> End([Cancellation - complete])
137137
Skip --> End
138138
NotifyRestaurant --> End
139139
@@ -159,8 +159,8 @@ stateDiagram-v2
159159
[*] --> Confirmed: Booking created
160160
161161
Confirmed --> InProgress: Booking time arrives
162-
InProgress --> Completed: Diner shows up<br/>(Host marks 'Seated')
163-
InProgress --> NoShow: Diner doesn't arrive<br/>(15 min past booking time)
162+
InProgress --> Completed: Diner shows up, Host marks Seated
163+
InProgress --> NoShow: Diner doesnt arrive, 15 min past booking time
164164
165165
Completed --> RefundDeposit: If deposit paid
166166
RefundDeposit --> [*]

02-reserve-easy-project/06-qa/test-cases/TC-001-guest-booking.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@
5353
| 16 | Leave "Special Requests" field empty (optional) | Field remains empty, no error |
5454
| 17 | Click "Confirm Booking" button | Loading spinner appears for 1-3 seconds |
5555
| 18 | Wait for confirmation page to load | Confirmation page displays within 5 seconds |
56-
| 19 | Verify confirmation page content: <br/>- "Booking Confirmed!" heading<br/>- Restaurant name: "Bella Italia"<br/>- Date: Tomorrow's date<br/>- Time: 7:00 PM<br/>- Party size: 4<br/>- Confirmation code: 6-character alphanumeric (e.g., "XYZ123") | All details match booking inputs, confirmation code is displayed |
56+
| 19 | Verify confirmation page content: - - "Booking Confirmed!" heading - - Restaurant name: "Bella Italia" - - Date: Tomorrow's date - - Time: 7:00 PM - - Party size: 4 - - Confirmation code: 6-character alphanumeric (e.g., "XYZ123") | All details match booking inputs, confirmation code is displayed |
5757
| 20 | Check phone +15551234567 for SMS | SMS received within 30 seconds |
58-
| 21 | Verify SMS content:<br/>- Contains "Bella Italia"<br/>- Contains date and time<br/>- Contains party size "4"<br/>- Contains confirmation code<br/>- Contains link to modify/cancel | All required information is present in SMS |
58+
| 21 | Verify SMS content: - - Contains "Bella Italia" - - Contains date and time - - Contains party size "4" - - Contains confirmation code - - Contains link to modify/cancel | All required information is present in SMS |
5959
| 22 | Click link in SMS (optional) | Opens booking details page with Modify/Cancel options |
6060

6161
---

04-career-portfolio/pm-portfolio-guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -238,8 +238,8 @@ notion.so/yourname/product-portfolio
238238

239239
## Tools to Showcase in Portfolio
240240

241-
| Category | Tools to Mention |
242-
| ----------------------- | -------------------------------------------------- |
241+
| Category | Tools to Mention |
242+
| ----------------- | -------------------------------------------------- |
243243
| **Analytics** | SQL, Mixpanel, Amplitude, Google Analytics, Looker |
244244
| **Design** | Figma (link mockups), Miro (link roadmaps) |
245245
| **Project Mgmt** | Jira, Linear, Asana |
@@ -264,8 +264,8 @@ notion.so/yourname/product-portfolio
264264

265265
**Great PM Portfolios:**
266266

267-
- [Lenny Rachitsky&#39;s Blog](https://www.lennysnewsletter.com) - PM best practices, case studies
268-
- [Jackie Bavaro&#39;s Portfolio](https://jackiebavaro.com) - Asana PM, clear case studies
267+
- [Lenny Rachitsky's Blog](https://www.lennysnewsletter.com) - PM best practices, case studies
268+
- [Jackie Bavaro's Portfolio](https://jackiebavaro.com) - Asana PM, clear case studies
269269
- [Ken Norton essays](https://www.bringthedonuts.com) - Google PM, thought leadership
270270

271271
---

0 commit comments

Comments
 (0)