Skip to content

Commit 846c19f

Browse files
committed
added a pyansys use case
1 parent 798360e commit 846c19f

File tree

3 files changed

+121
-0
lines changed

3 files changed

+121
-0
lines changed
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"build": {
3+
"globalMetadata": {
4+
"title": "PyAnsys use case",
5+
"summary": "",
6+
"version": "2025 R2",
7+
"product": "PyAnsys",
8+
"programming language": "",
9+
"physics": "Shared Components"
10+
}
11+
}
12+
}
Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
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)**
15+
16+
* 2–3 sentences summarizing **what the use case achieves** and **why it matters**.
17+
* Focus on **business impact**: time saved, cost reduction, or improved efficiency.
18+
*Example:* “This use case demonstrates how integrating the ModelCenter API automates report creation, reducing manual effort by 60%.”
19+
20+
---
21+
22+
### 3. **Problem / Challenge**
23+
24+
* Describe the issue or inefficiency faced before the solution.
25+
* Make it relatable to the reader’s context (operational, business, or technical).
26+
*Example:* “Teams were generating reports manually, leading to delays and inconsistent outputs.”
27+
28+
---
29+
30+
### 4. **Solution Overview**
31+
32+
* Summarize how your product (API, SDK, service, etc.) solves the problem.
33+
* Include a high-level architecture diagram or workflow if relevant.
34+
*Example:* “Using the ModelCenter API, reports are now generated automatically based on CSV inputs and scheduled tasks.”
35+
36+
---
37+
38+
### 5. **Implementation Details (Developer View)**
39+
40+
Break this down into short, clear sections:
41+
42+
* **Architecture / Flow Diagram** – how components interact.
43+
* **Technologies / APIs Used** – name specific endpoints, SDKs, or libraries.
44+
* **Steps to Reproduce / Implement** – short, numbered steps with code snippets.
45+
* **Configuration / Deployment Notes** – optional but appreciated by devs.
46+
47+
> 💡 Keep this practical and focused — show what to do, not just what happens.
48+
49+
---
50+
51+
### 6. **Results / Benefits**
52+
53+
* Quantify improvements where possible.
54+
* Include both **technical** and **business** metrics.
55+
*Example:*
56+
57+
* “Report generation time reduced from 45 minutes to under 5.”
58+
* “Developers can now trigger and schedule reports with minimal setup.”
59+
60+
---
61+
62+
### 7. **Key Takeaways / Lessons Learned**
63+
64+
* 2–3 bullet points summarizing what users should remember.
65+
*Example:*
66+
67+
* “Leverage the API’s automation features for consistent reporting.”
68+
* “Template reuse ensures scalable documentation generation.”
69+
70+
---
71+
72+
### 8. **Resources / References**
73+
74+
* Link to:
75+
76+
* API documentation
77+
* GitHub repo or code sample
78+
* Related tutorials
79+
* Product page or contact info
80+
81+
---
82+
83+
### 9. **Optional: Executive Snapshot**
84+
85+
If your portal serves mixed audiences, you can provide a **summary box** at the top (or side) that highlights:
86+
87+
* **Business value**
88+
* **Technical complexity** (Low/Medium/High)
89+
* **Estimated implementation time**
90+
* **Main API used**
91+
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.

Other_Tests/use-cases/pyansys/toc.yml

Whitespace-only changes.

0 commit comments

Comments
 (0)