Skip to content

Commit 641bb2d

Browse files
committed
added a pyansys use case
1 parent cab25bc commit 641bb2d

File tree

1 file changed

+8
-39
lines changed

1 file changed

+8
-39
lines changed
Lines changed: 8 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,28 @@
1-
# PyAnsys use case
2-
3-
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
152

163
* 2–3 sentences summarizing **what the use case achieves** and **why it matters**.
174
* Focus on **business impact**: time saved, cost reduction, or improved efficiency.
185
*Example:* “This use case demonstrates how integrating the ModelCenter API automates report creation, reducing manual effort by 60%.”
196

207
---
218

22-
### 3. **Problem / Challenge**
9+
## Problem / Challenge
2310

2411
* Describe the issue or inefficiency faced before the solution.
2512
* Make it relatable to the reader’s context (operational, business, or technical).
2613
*Example:* “Teams were generating reports manually, leading to delays and inconsistent outputs.”
2714

2815
---
2916

30-
### 4. **Solution Overview**
17+
## Solution Overview
3118

3219
* Summarize how your product (API, SDK, service, etc.) solves the problem.
3320
* Include a high-level architecture diagram or workflow if relevant.
3421
*Example:* “Using the ModelCenter API, reports are now generated automatically based on CSV inputs and scheduled tasks.”
3522

3623
---
3724

38-
### 5. **Implementation Details (Developer View)**
25+
## Implementation Details (Developer View)
3926

4027
Break this down into short, clear sections:
4128

@@ -48,7 +35,7 @@ Break this down into short, clear sections:
4835
4936
---
5037

51-
### 6. **Results / Benefits**
38+
## Results / Benefits
5239

5340
* Quantify improvements where possible.
5441
* Include both **technical** and **business** metrics.
@@ -59,7 +46,7 @@ Break this down into short, clear sections:
5946

6047
---
6148

62-
### 7. **Key Takeaways / Lessons Learned**
49+
## Key Takeaways / Lessons Learned
6350

6451
* 2–3 bullet points summarizing what users should remember.
6552
*Example:*
@@ -69,7 +56,7 @@ Break this down into short, clear sections:
6956

7057
---
7158

72-
### 8. **Resources / References**
59+
## Resources / References
7360

7461
* Link to:
7562

@@ -80,7 +67,7 @@ Break this down into short, clear sections:
8067

8168
---
8269

83-
### 9. **Optional: Executive Snapshot**
70+
## Optional: Executive Snapshot
8471

8572
If your portal serves mixed audiences, you can provide a **summary box** at the top (or side) that highlights:
8673

@@ -89,21 +76,3 @@ If your portal serves mixed audiences, you can provide a **summary box** at the
8976
* **Estimated implementation time**
9077
* **Main API used**
9178

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

Comments
 (0)