نوشتناسکیل
ساخت مستندات فنی
این اسکیل برای ساخت مستندات فنی و نمودارهای حرفهای با استفاده از **Mermaid** طراحی شده است
متن پرامپت
نصب
bash
npx skills add https://github.com/spillwavesolutions/design-doc-mermaid --skill design-doc-mermaidمعرفی
این اسکیل برای ساخت مستندات فنی و نمودارهای حرفهای با استفاده از Mermaid طراحی شده است. با کمک آن میتوان از درخواست کاربر، نوع مناسب نمودار یا سند را تشخیص داد و خروجی استاندارد تولید کرد.
این ابزار برای موارد زیر کاربرد دارد:
- ساخت نمودارهای فرآیندی و گردش کار
- طراحی معماری سیستمها
- نمایش زیرساخت و استقرار (Cloud، Kubernetes و شبکه)
- ایجاد نمودارهای Sequence برای ارتباط سرویسها و APIها
- تبدیل کد به نمودار معماری و جریان
- ساخت مستندات طراحی سیستم، API، دیتابیس و قابلیتها
قابلیتها
| قابلیت | کاربرد |
|---|---|
| نمودارهای Mermaid | ساخت نمودارهای قابل استفاده در Markdown |
| Code-to-Diagram | تبدیل ساختار کد به نمودار |
| قالبهای طراحی | تولید مستندات استاندارد معماری، API و سیستم |
| اعتبارسنجی نمودار | بررسی خطاهای Mermaid قبل از خروجی نهایی |
| تبدیل نمودار به تصویر | خروجی PNG یا SVG از نمودارها |
| نمادهای معنایی | استفاده از آیکونها و Unicode برای خوانایی بیشتر |
نحوه عملکرد
- درخواست کاربر بررسی میشود.
- نوع خروجی مورد نیاز تشخیص داده میشود.
- راهنمای مناسب برای آن نوع نمودار یا سند بارگذاری میشود.
- خروجی با قالبها و الگوهای آماده ساخته میشود.
- در صورت نیاز، نمودار اعتبارسنجی و به تصویر تبدیل میشود.
نمونه کاربردها
| درخواست | خروجی مناسب |
|---|---|
| "فرآیند ورود کاربر را رسم کن" | Activity Diagram |
| "معماری AWS را نمایش بده" | Deployment Diagram |
| "ساختار Microservice را توضیح بده" | Architecture Diagram |
| "جریان درخواست API را نشان بده" | Sequence Diagram |
| "از کد Spring Boot نمودار بساز" | Code-to-Diagram |
| "مستند طراحی سیستم ایجاد کن" | Design Document |
ابزارهای کمکی
- استخراج نمودارها از فایل Markdown
- اعتبارسنجی سینتکس Mermaid
- تبدیل فایلهای Mermaid به PNG/SVG
- تولید نمودار با قابلیت بازیابی خطا و اصلاح خودکار
نکات مهم
- هر نمودار باید فقط یک مفهوم مشخص را نمایش دهد.
- قبل از اضافه کردن نمودار به مستندات، اعتبارسنجی انجام شود.
- برای خوانایی بهتر از نمادهای معنایی استفاده شود.
- از قالبهای آماده برای تولید مستندات یکپارچه استفاده شود.