ایجاد استراتژی مستندسازی فنی
این پرامپت به متخصصان کمک می‌کند تا یک استراتژی جامع برای مستندسازی فنی توسعه دهند که متناسب با سازمان، محصول یا پروژه آن‌ها باشد. این ابزار برای نویسندگان فنی، مدیران محصول، مهندسان نرم‌افزار و تیم‌های مستندسازی طراحی شده است تا فرآیندهای مستندسازی خود را سازماندهی، استانداردسازی و بهینه کنند. با استفاده از این پرامپت می‌توان برنامه‌های دقیقی ایجاد کرد که شامل انواع مستندات، تحلیل مخاطب، استانداردهای محتوا، جریان‌های کاری و استراتژی‌های نگهداری و به‌روزرسانی باشد. این پرامپت مشکلات رایجی مانند مستندسازی ناهماهنگ، عدم شفافیت در شناخت مخاطب، کمبود قالب‌ها و فرآیندهای به‌روزرسانی ناکارآمد را حل می‌کند. با اجرای این پرامپت، تیم‌ها می‌توانند اطمینان حاصل کنند که تمام محتوای فنی—مانند راهنماهای کاربری، مستندات API، دفترچه‌های راهنمای رفع مشکل و پایگاه‌های دانش داخلی—واضح، منسجم و قابل نگهداری است. نتیجه، یک استراتژی عملی، حرفه‌ای و قابل اجرا است که باعث بهبود ارتباطات، کاهش خطاها و افزایش رضایت کاربران می‌شود و در عین حال زمان مورد نیاز برای پروژه‌های مستندسازی آینده را کاهش می‌دهد.
پرامپت هوش مصنوعی
نحوه استفاده
1. `[نام پروژه/محصول]` را با نام واقعی پروژه یا محصول جایگزین کنید.
2. هر بخش را مرور کرده و نیازهای خاص سازمان، مانند استانداردهای انطباق یا قالب‌های داخلی، را اضافه کنید.
3. پرامپت را در هر ابزار هوش مصنوعی که قابلیت تولید متن دارد اجرا کنید تا یک استراتژی سازمان‌یافته دریافت کنید.
4. اطمینان حاصل کنید که تمام انواع مستندات و مراحل جریان کاری پوشش داده شده‌اند.
5. لحن و سبک را بر اساس مخاطب هدف تنظیم کنید (کارکنان داخلی در مقابل کاربران نهایی).
6. از اصطلاحات مبهم خودداری کرده و ابزارها، پلتفرم‌ها و فرآیندها را مشخص کنید.
موارد استفاده
برنامه‌ریزی مستندسازی برای پروژه‌های نرم‌افزاری جدید.
استانداردسازی مستندات در تیم‌های متعدد.
ایجاد پایگاه‌های دانش داخلی برای نرم‌افزارهای سازمانی.
تهیه مستندات API برای توسعه‌دهندگان.
بهبود راهنماهای کاربری محصولات مشتری‌محور.
ایجاد جریان‌های بررسی و تأیید مستندات.
تعریف شاخص‌های سنجش اثربخشی مستندات.
نگهداری بلندمدت مستندات فنی سیستم‌های پیچیده.
نکات حرفه‌ای
مخاطب را دقیق مشخص کنید تا محتوای تولید شده متناسب با سطح دانش آن‌ها باشد.
ابزارها و پلتفرم‌های مشخص را برای عملیاتی کردن استراتژی درج کنید.
از هوش مصنوعی بخواهید نمونه‌ها یا قالب‌هایی برای هر نوع مستند ارائه دهد.
از پرامپت‌های تکراری برای جزئی‌تر کردن هر بخش استفاده کنید.
استراتژی را به صورت منظم به‌روزرسانی کنید تا با تغییر محصولات و نسخه‌ها هماهنگ باشد.
پرامپت‌های مرتبط
ایجاد برنامه مستندسازی نرم‌افزار
این پرامپت به حرفه‌ای‌ها کمک می‌کند تا یک برنامه جامع برای مستندسازی نرم‌افزار ایجاد کنند که به‌طور خاص برای نیازهای …
یک برنامه مستندسازی نرم‌افزار دقیق برای پروژه \[نام نرم‌افزار یا پروژه] ایجاد کن. در برنامه …
نوشتن مقالات فنی برای وبلاگ
این پرامپت برای کمک به حرفه‌ای‌ها، نویسندگان فنی و تولیدکنندگان محتوا طراحی شده است تا مقالات فنی با کیفیت بالا، …
یک مقاله فنی کامل درباره \[موضوع] بنویس که مخاطب آن \[مخاطب هدف] باشد. مقاله باید …
تدوین استراتژی محتوای فنی
این پرامپت به متخصصان، مدیران محتوا و نویسندگان فنی کمک می‌کند تا یک استراتژی محتوای فنی جامع و متناسب با …
به عنوان یک استراتژیست محتوای فنی عمل کنید. یک استراتژی محتوای فنی دقیق برای \[نام …
توسعه پایگاه دانش
این پرامپت برای کمک به متخصصان، نویسندگان فنی و مدیران دانش طراحی شده است تا پایگاه‌های دانش جامع و ساختارمند …
به‌عنوان یک کارشناس نویسندگی فنی و مدیریت دانش عمل کنید. یک پایگاه دانش جامع برای …
بیشتر از نگارش فنی
توسعه چارچوب مستندسازی Api
این پرامپت برای کمک به نویسندگان فنی، توسعه‌دهندگان نرم‌افزار و تیم‌های توسعه API طراحی شده است تا یک چارچوب ساختاریافته …
یک چارچوب جامع مستندسازی برای API \[نام پروژه/API] ایجاد کنید. این چارچوب باید شامل بخش‌های …
راهنمای طراحی و نگارش دفترچه راهنمای کاربر
این پرامپت برای کمک به نویسندگان فنی، مدیران محصول، مهندسین و تیم‌های پشتیبانی طراحی شده است تا دفترچه راهنمای کاربر …
یک دفترچه راهنمای کاربر کامل، ساختارمند و حرفه‌ای برای \[نام محصول، نرم‌افزار یا سرویس] به …
ایجاد برنامه مستندسازی نرم‌افزار
این پرامپت به حرفه‌ای‌ها کمک می‌کند تا یک برنامه جامع برای مستندسازی نرم‌افزار ایجاد کنند که به‌طور خاص برای نیازهای …
یک برنامه مستندسازی نرم‌افزار دقیق برای پروژه \[نام نرم‌افزار یا پروژه] ایجاد کن. در برنامه …
ایجاد چارچوب مستندسازی فرایندها
این پرامپت برای متخصصان و سازمان‌هایی طراحی شده است که نیاز به ایجاد یک چارچوب جامع و استاندارد برای مستندسازی …
«به‌عنوان یک نویسنده فنی حرفه‌ای و طراح فرایند عمل کن. یک چارچوب مستندسازی فرایند ایجاد …
استراتژی طراحی دفترچه راهنمای آموزش
این پرامپت برای کمک به متخصصان، نویسندگان فنی و طراحان آموزشی طراحی شده است تا یک استراتژی جامع برای ایجاد …
یک استراتژی جامع برای طراحی دفترچه راهنمای آموزش برای \[محصول/فرآیند/سیستم] ایجاد کنید. این استراتژی باید …
تدوین استراتژی محتوای فنی
این پرامپت به متخصصان، مدیران محتوا و نویسندگان فنی کمک می‌کند تا یک استراتژی محتوای فنی جامع و متناسب با …
به عنوان یک استراتژیست محتوای فنی عمل کنید. یک استراتژی محتوای فنی دقیق برای \[نام …
توسعه پایگاه دانش
این پرامپت برای کمک به متخصصان، نویسندگان فنی و مدیران دانش طراحی شده است تا پایگاه‌های دانش جامع و ساختارمند …
به‌عنوان یک کارشناس نویسندگی فنی و مدیریت دانش عمل کنید. یک پایگاه دانش جامع برای …
نوشتن مقالات فنی برای وبلاگ
این پرامپت برای کمک به حرفه‌ای‌ها، نویسندگان فنی و تولیدکنندگان محتوا طراحی شده است تا مقالات فنی با کیفیت بالا، …
یک مقاله فنی کامل درباره \[موضوع] بنویس که مخاطب آن \[مخاطب هدف] باشد. مقاله باید …