You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
That’s a great initiative — adding **use cases** to your developer portal will make it far more engaging and valuable for both technical and executive audiences.
4
-
5
-
Here’s a clear, flexible **structure** you can use that works well for **developer + executive readers**:
6
-
7
-
## 🧩 **Recommended Structure for Developer Portal Use Cases**
8
-
9
-
* Short, action-oriented, and specific.
10
-
→ *Example:* “Automating Report Generation Using the ModelCenter API”
11
-
12
-
---
13
-
14
-
### 2. **Summary (Executive View)**
1
+
# Summary
15
2
16
3
* 2–3 sentences summarizing **what the use case achieves** and **why it matters**.
17
4
* Focus on **business impact**: time saved, cost reduction, or improved efficiency.
18
5
→ *Example:* “This use case demonstrates how integrating the ModelCenter API automates report creation, reducing manual effort by 60%.”
19
6
20
7
---
21
8
22
-
### 3. **Problem / Challenge**
9
+
##Problem / Challenge
23
10
24
11
* Describe the issue or inefficiency faced before the solution.
25
12
* Make it relatable to the reader’s context (operational, business, or technical).
26
13
→ *Example:* “Teams were generating reports manually, leading to delays and inconsistent outputs.”
27
14
28
15
---
29
16
30
-
### 4. **Solution Overview**
17
+
##Solution Overview
31
18
32
19
* Summarize how your product (API, SDK, service, etc.) solves the problem.
33
20
* Include a high-level architecture diagram or workflow if relevant.
34
21
→ *Example:* “Using the ModelCenter API, reports are now generated automatically based on CSV inputs and scheduled tasks.”
@@ -48,7 +35,7 @@ Break this down into short, clear sections:
48
35
49
36
---
50
37
51
-
### 6. **Results / Benefits**
38
+
##Results / Benefits
52
39
53
40
* Quantify improvements where possible.
54
41
* Include both **technical** and **business** metrics.
@@ -59,7 +46,7 @@ Break this down into short, clear sections:
59
46
60
47
---
61
48
62
-
### 7. **Key Takeaways / Lessons Learned**
49
+
##Key Takeaways / Lessons Learned
63
50
64
51
* 2–3 bullet points summarizing what users should remember.
65
52
→ *Example:*
@@ -69,7 +56,7 @@ Break this down into short, clear sections:
69
56
70
57
---
71
58
72
-
### 8. **Resources / References**
59
+
##Resources / References
73
60
74
61
* Link to:
75
62
@@ -80,7 +67,7 @@ Break this down into short, clear sections:
80
67
81
68
---
82
69
83
-
### 9. **Optional: Executive Snapshot**
70
+
##Optional: Executive Snapshot
84
71
85
72
If your portal serves mixed audiences, you can provide a **summary box** at the top (or side) that highlights:
86
73
@@ -89,21 +76,3 @@ If your portal serves mixed audiences, you can provide a **summary box** at the
89
76
***Estimated implementation time**
90
77
***Main API used**
91
78
92
-
---
93
-
94
-
## Example Headings Template
95
-
96
-
```
97
-
# Use Case: Automating Report Creation with ModelCenter API
98
-
## Summary
99
-
## Problem
100
-
## Solution
101
-
## Implementation Details
102
-
## Results
103
-
## Key Takeaways
104
-
## Resources
105
-
```
106
-
107
-
---
108
-
109
-
Would you like me to create a **sample filled-out use case** (e.g., for the “report automation with API” you mentioned earlier) using this structure? That way you can see how it reads in practice for both developers and executives.
0 commit comments