توضیحات

آموزش صفر تا صد نوشتن مستندات نرم افزار

نام دوره : Technical Writing: How to Write Software Documentation

پیش‌نیاز

• شما به یک کامپیوتر یا لپ‌تاپ نیاز دارید که بتوانید بر روی آن تکالیف محتوایی را توسعه داده و یا نرم‌افزارهای خاصی که در طول دوره به صورت آزمایشی از آن‌ها استفاده خواهیم کرد، نصب کنید.

توضیحات

آیا توانایی ارائه اطلاعات مرتبط درباره نحوه استفاده از نرم‌افزار برای مشتریان شما ضروری است؟

آیا ساعات زیادی را صرف تلاش برای توضیح نحوه استفاده از نرم‌افزار می‌کنید؟

یا بازخوردهایی از مشتریان دریافت کرده‌اید که مستندات شما سخت‌فهم، ناهماهنگ یا حتی… گیج‌کننده است؟

اگر به هر یک از این سوالات با “بله!” پاسخ داده‌اید و مایلید زمان و انرژی لازم برای گذراندن این دوره عملی را سرمایه‌گذاری کنید، پس این دوره برای شماست!

CNBC در مقاله “20 مهارت داغ شغلی که شرکت‌ها اکنون به دنبال آن هستند” به این دوره اشاره کرده است.

در پایان این دوره:

• شما قادر خواهید بود مراحل مورد نیاز را انجام داده و به عنوان یک نویسنده فنی شروع به نوشتن مستندات کنید.
• شما قادر خواهید بود فرآیند آماده‌سازی، سازماندهی و تحویل مستندات نرم‌افزاری برای کاربران محصولات نرم‌افزاری را توضیح دهید.
• شما می‌توانید تصاویر و گرافیک‌های آموزشی لازم در مستندات خود را با استفاده از Canva ایجاد کنید.
• شما یاد می‌گیرید و تمرین می‌کنید که چگونه مستندات نرم‌افزاری را در ویکی GitHub با استفاده از قالب‌های نویسنده در Markdown بنویسید.
• شما می‌دانید که چگونه از دو تکنیک Cards Sorting در Mural برای انجام تحقیقات کاربران استفاده کنید.
• شما قادر خواهید بود جنبه‌های مختلفی که باعث می‌شود مستندات به یک محصول با کیفیت بالا تبدیل شوند را شناسایی کنید.

همچنین:

• شما اصول اصلی نوشتن مستندات نرم‌افزاری که واقعاً کمک‌کننده است را نیز خواهید یافت.
• شما این فرصت را خواهید داشت که ویرایشگر ویکی GitHub را برای نوشتن امتحان کنید.
• شما یاد خواهید گرفت که اهمیت گرافیک چیست و از چه ابزارهایی می‌توانید برای ایجاد گرافیک‌های آموزشی به راحتی استفاده کنید.
• در پایان، شما بیشتر در مورد معماری اطلاعات و اهمیت آن در مستندات نرم‌افزاری خواهید آموخت.
• در نهایت، شما این فرصت را خواهید داشت که پروژه مستندات خود را ایجاد کنید، حتی اگر قبلاً به عنوان یک نویسنده فنی کار نکرده‌اید و هیچ تجربه‌ای ندارید.

در طول سال‌ها، فعالیت‌های اصلی حرفه‌ای نویسندگان فنی به طور مداوم در حال تکامل بوده است.

ما به عنوان نویسندگان فنی شروع به کار کردیم و تنها بر نویسندگی فنی تمرکز داشتیم.

ما به توسعه‌دهندگان اطلاعات تبدیل شدیم که جنبه‌های گرافیکی و طراحی محتوا را نیز در نظر می‌گیرند. امروزه، ما باید مهارت‌های نویسندگی، طراحی و گرافیک، ایجاد ویدئو، چندرسانه‌ای، متادیتا، و توسعه نرم‌افزار را با هم ترکیب کنیم تا انتظارات کاربرانمان را برآورده کنیم.

همه این دارایی‌ها را می‌توان به عنوان “کمک به کاربر” توصیف کرد.

در آموزش صفر تا صد نوشتن مستندات نرم افزار چه چیزی یاد خواهید گرفت؟

این دوره برای نویسندگان فنی مبتدی طراحی شده است، معمولاً دانشجویان در رشته IT، و موضوعات زیر را پوشش می‌دهد:

• نویسندگی فنی چیست؟
• اصول اولیه نویسندگی فنی چیست؟
• اصطلاحات رایجی که در دنیای نویسندگی فنی IT خواهید شنید و استفاده خواهید کرد، چیست؟
• چگونه مستندات فنی را با استفاده از ویکی GitHub بنویسیم؟ شما بعدها از این مطالب برای ایجاد پورتفولیو خود استفاده خواهید کرد که می‌خواهید به رزومه خود اضافه کنید وقتی که برای شغل نویسندگی فنی یا ارتقا به توسعه‌دهنده ارشد درخواست می‌دهید.
• معماری اطلاعات از دیدگاه نویسندگی فنی چیست؟

تا پایان این دوره، شما می‌دانید که چگونه نوشتن راهنماهای کاربری خود را شروع کنید، کدام بهترین شیوه‌ها و قوانین را در نظر بگیرید و از کدام ابزارها برای نوشتن استفاده کنید.

توجه داشته باشید که برای دسترسی بهتر، دوره با زیرنویس‌های انگلیسی و اسپانیایی ارائه می‌شود.

علاوه بر این:

• شما همچنین وبینارهای ضبط‌شده‌ای را خواهید یافت که به شما حس حضور در کلاس دانشگاهی با دیگر دانشجویان در حال انجام تمرین‌های دوره را می‌دهد.
• شما به یک گروه اجتماعی بسته دسترسی خواهید داشت، جایی که می‌توانید با دیگر دانشجویان نویسندگی فنی یاد بگیرید.
• شما این فرصت را خواهید داشت که در وبینارهای زنده با مدرس شرکت کنید، تا راهنمایی‌ها و پاسخ‌های سوالات خود را دریافت کنید.
• مطالب قابل دانلود در بخش‌ها به شما کمک می‌کنند که در طول محتوا حرکت کنید و آنچه را که آموخته‌اید تمرین کنید.

چه چیزی در این دوره پوشش داده نمی‌شود؟

یادگیری نویسندگی فنی به عنوان یک نویسنده فنی مبتدی حداقل دو ترم در دانشگاه و تمرینات نوشتن زیادی خواهد گرفت.

ارائه اطلاعات عمیق درباره همه موضوعات نویسندگی فنی در یک دوره 4-6 ساعته امکان‌پذیر نیست. اما اصول اولیه را خواهید دانست!

• این یک دوره در مورد نوشتن با استفاده از MS Word نیست! ما قرار نیست کتاب بنویسیم! ما قرار نیست مستندات غیرساختاری بنویسیم!
• برخلاف آنچه دیگر دوره‌ها درباره نویسندگی فنی به شما می‌گویند، MS Word بدترین انتخاب برای نوشتن مستندات فنی است! این نرم‌افزار مقیاس‌پذیری ندارد و به اندازه کافی برای مستندات نرم‌افزاری انعطاف‌پذیر نیست! اگر باور دارید که نویسندگی فنی درباره نوشتن کتاب است، لطفاً دوره دیگری را انتخاب کنید! این دوره برای افرادی است که می‌خواهند در صنعت نرم‌افزار کار کنند، جایی که نوشتن یک کتاب و آن را “مستندات نرم‌افزاری” نامیدن، خوب درک نمی‌شود!
• نویسندگی فنی یک مهارت و یک رشته است که نیاز به نوشتن دارد. انتظار نداشته باشید که با گوش دادن به چند سخنرانی به یک نویسنده فنی تبدیل شوید. شما باید در این دوره بنویسید و ارتباط برقرار کنید. این یک دوره برای گوش دادن نیست، بلکه یک دوره “گوش کن و انجام بده!” است.
• این یک دوره زبان انگلیسی نیست. ما جزئیات مربوط به نحوه نوشتن به انگلیسی را ارائه نمی‌دهیم.
• ابزارهای زیادی وجود دارند که می‌توانید برای نوشتن استفاده کنید. در این دوره، ما وارد جزئیات ابزارهای نوشتن نمی‌شویم بلکه فقط 1-2 مورد را برای شروع به شما پیشنهاد می‌دهیم.
• ما مستندات API را در این دوره پوشش نمی‌دهیم. مستندات API نوعی مستندات نرم‌افزاری است که هنوز باید تحویل داده شود، اما در حال حاضر، این دوره درباره آن صحبت نمی‌کند. به دوره “چگونه مستندات API بنویسیم” ما نگاه کنید.

چقدر زمان برای گذراندن دوره آموزش صفر تا صد نوشتن مستندات نرم افزار نیاز است؟

• پاسخ کوتاه:
• بخش 1: شروع با نویسندگی فنی – 1 ساعت
• بخش 2: نوشتن مستندات نرم‌افزاری در GitHub با استفاده از Markdown – 2+ ساعت
• بخش 3: گرافیک در مستندات نرم‌افزاری – 40 دقیقه
• بخش 4: اصول معماری اطلاعات – 1+ ساعت
• بخش 5: کیفیت در مستندات نرم‌افزاری 40+ دقیقه
• بخش اضافی: وبینارهای اضافی – 3+ ساعت

دوره آموزش صفر تا صد نوشتن مستندات نرم افزار برای چه کسانی مناسب است؟

• توسعه‌دهندگان نرم‌افزار که می‌خواهند دانش عملی درباره چگونگی ارائه کمک به کاربران محصولات نرم‌افزاری کسب کنند.
• دانشجویانی که بر روی پروژه‌های توسعه نرم‌افزار خود کار می‌کنند و اکنون در ایجاد مستندات تحویلی برای برنامه خود مشکل دارند.
• اگر به دنبال شغلی به عنوان نویسنده فنی، توسعه‌دهنده، معمار، مدیر یا صاحب محصول هستید.
• تحلیل‌گران کسب و کاری که می‌خواهند اصول اولیه نویسندگی فنی را بدانند.
• نویسندگان فنی و توسعه‌دهندگان اطلاعات.

بخشی از دوره :