این دوره اصول نوشتن مستندات نرمافزاری موثر را پوشش میدهد. چه نیاز به مستندسازی نیازمندیها، معماری/طراحی، کد، طرحهای آزمایشی یا دستورالعملهای راهنمای کاربران نهایی داشته باشید، این دوره نکات و بهترین روشها را برای انجام همه این کارها به شما ارائه میدهد.
آنچه خواهید آموخت: اصطلاح `نوشتن فنی` بسته به رشته و نقش شما میتواند معانی مختلفی داشته باشد. اما در هسته آن، در مورد ارتباط اطلاعات است. در این دوره آموزشی، Technical Writing: Documentation on Software Projects، شما یاد خواهید گرفت که چگونه مستندات یک پروژه نرمافزاری را بنویسید، از جمله الزامات، سند معماری/طراحی، اسناد کد، طرحهای آزمایشی و موارد آزمایشی، و مستندات کاربر نهایی. ابتدا، میآموزید که اسناد در دنیای نرمافزار چقدر مهم هستند و فرآیند نوشتن چگونه کار میکند. سپس، چند نکته و بهترین شیوه برای نوشتن واضح و کارآمد را یاد خواهید گرفت. در نهایت، با اسناد رایج در یک پروژه نرمافزاری آشنا خواهید شد. وقتی این دوره را تمام کردید، درک اساسی از نوشتن فنی و نحوه برقراری ارتباط موثر در یک پروژه نرمافزاری خواهید داشت.
نمونه ویدیوی آموزشی ( زیرنویسها جدا از ویدیو است و میتوانید آنرا نمایش ندهید ) :
[ENGLISH]
01 Course Overview [1min]
01-01 Course Overview [1mins]
02 Introduction to Technical Writing [18mins]
02-01 Let Me Tell You a Story... [3mins]
02-02 But I`m a Developer, Not a Writer... [5mins]
02-03 Why Technical Writing Is Important (Even for Developers) [6mins]
02-04 Technical Writing- An Overview [2mins]
02-05 Course Outline and Prerequisites [2mins]
03 The Writing Process [28mins]
03-01 The Writing Process- An Overview [2mins]
03-02 The Planning Phase- Purpose [3mins]
03-03 The Planning Phase- Audience [6mins]
03-04 The Planning Phase- Delivery [1mins]
03-05 The Research Phase [6mins]
03-06 The Writing Phase [2mins]
03-07 The Reviewing Editing Phase [5mins]
03-08 The Launch Phase [1mins]
03-09 Summary [2mins]
04 Writing Tips and Best Practices [33mins]
04-01 Writing Tips and Best Practices- An Overview [2mins]
04-02 Accuracy [3mins]
04-03 Clarity [9mins]
04-04 Conciseness [6mins]
04-05 Tone [2mins]
04-06 Tense [2mins]
04-07 Grammar, Spelling, and Terminology [7mins]
04-08 Summary and Additional Resources [2mins]
05 Layout and Design [39mins]
05-01 Layout and Design- An Overview [0mins]
05-02 Typography- The Basics [5mins]
05-03 Typography- Guidelines [5mins]
05-04 Design Principles- An Overview [1mins]
05-05 Alignment [4mins]
05-06 Proximity [3mins]
05-07 Contrast [7mins]
05-08 Whitespace [2mins]
05-09 Page Design Elements [6mins]
05-10 Visuals [3mins]
05-11 Summary [3mins]
06 Deliverables- Requirements [33mins]
06-01 Requirements- An Overview [1mins]
06-02 Poor Requirements = Project Failure [3mins]
06-03 Good Requirements = Much Better Chance! [4mins]
06-04 Requirement Writing Styles [3mins]
06-05 User Stories [3mins]
06-06 Traditional (Text-based) Requirements [3mins]
06-07 Use Cases [6mins]
06-08 Types of Requirements [4mins]
06-09 Software Requirements Specification (SRS) [4mins]
06-10 Summary and Additional Resources [2mins]
07 Deliverables- Design Architecture [12mins]
07-01 Design Architecture Documentation- An Overview [1mins]
07-02 Software Design Document (SDD) [4mins]
07-03 SDD Sections- Introduction [2mins]
07-04 SDD Sections- System Architecture [1mins]
07-05 SDD Sections- Detailed System Design [1mins]
07-06 SDD Sections- Data Design [1mins]
07-07 SDD Sections- User Interface [1mins]
07-08 Summary [1mins]
08 Deliverables- Code Documentation [19mins]
08-01 Code Documentation- An Overview [1mins]
08-02 Code Comments [7mins]
08-03 API Documentation [3mins]
08-04 API Documentation- Demo [4mins]
08-05 README Files [3mins]
08-06 Summary [1mins]
09 Deliverables- Test Plans and Test Cases [16mins]
09-01 Test Plans and Test Cases- An Overview [2mins]
09-02 Test Plan- An Example [7mins]
09-03 Test Scenarios and Test Cases [1mins]
09-04 Writing Test Cases [4mins]
09-05 Summary and Additional Resources [2mins]
10 Deliverables- End-user Documentation [15mins]
10-01 End-user Documentation- An Overview [2mins]
10-02 User Guides [1mins]
10-03 User Guides- An Example [5mins]
10-04 Quick Reference Guides [2mins]
10-05 Release Notes [1mins]
10-06 Release Notes- An Example [3mins]
10-07 Summary [1mins]
11 Conclusion and Additional Resources [11mins]
11-01 The Beginning of the End [1mins]
11-02 Recap- Technical Writing and the Writing Process [2mins]
11-03 Recap- Writing Best Practices, Layout, and Design [2mins]
11-04 Recap- Deliverables [4mins]
11-05 The End of the Story [0mins]
11-06 Additional Resources [2mins]
[فارسی]
01 نمای کلی دوره [1 دقیقه]
01-01 بررسی اجمالی دوره [1 دقیقه]
02 مقدمهای بر نگارش فنی [18 دقیقه]
02-01 بگذار یک داستان برایت بگویم... [3 دقیقه]
02-02 اما من یک توسعه دهنده هستم، نه یک نویسنده... [5 دقیقه]
02-03 چرا نوشتن فنی مهم است (حتی برای توسعه دهندگان) [6 دقیقه]
02-04 نگارش فنی- مروری [2 دقیقه]
02-05 رئوس مطالب و پیش نیازهای دوره [2 دقیقه]
03 فرآیند نوشتن [28 دقیقه]
03-01 فرآیند نوشتن- یک مرور کلی [2 دقیقه]
03-02 مرحله برنامه ریزی- هدف [3 دقیقه]
03-03 مرحله برنامه ریزی- مخاطب [6 دقیقه]
03-04 مرحله برنامه ریزی- تحویل [1 دقیقه]
03-05 مرحله تحقیق [6 دقیقه]
03-06 مرحله نوشتن [2 دقیقه]
03-07 مرحله بازبینی ویرایش [5 دقیقه]
03-08 مرحله راه اندازی [1 دقیقه]
03-09 خلاصه [2 دقیقه]
04 نکات و بهترین شیوههای نوشتن [33 دقیقه]
04-01 نکات نوشتن و بهترین شیوه ها- یک مرور کلی [2 دقیقه]
04-02 دقت [3 دقیقه]
04-03 وضوح [9 دقیقه]
04-04 مختصر [6 دقیقه]
04-05 تن [2 دقیقه]
04-06 تنش [2 دقیقه]
04-07 دستور زبان، املا و اصطلاحات [7 دقیقه]
04-08 خلاصه و منابع اضافی [2 دقیقه]
05 چیدمان و طراحی [39 دقیقه]
05-01 چیدمان و طراحی- یک نمای کلی [0 دقیقه]
05-02 تایپوگرافی- اصول [5 دقیقه]
05-03 تایپوگرافی- دستورالعمل [5 دقیقه]
05-04 اصول طراحی- یک مرور کلی [1 دقیقه]
05-05 تراز کردن [4 دقیقه]
05-06 نزدیکی [3 دقیقه]
05-07 کنتراست [7 دقیقه]
05-08 فضای خالی [2 دقیقه]
05-09 عناصر طراحی صفحه [6 دقیقه]
05-10 تصاویری [3 دقیقه]
05-11 خلاصه [3 دقیقه]
06 موارد تحویلی- مورد نیاز [33 دقیقه]
06-01 شرایط مورد نیاز- یک مرور کلی [1 دقیقه]
06-02 الزامات ضعیف = شکست پروژه [3 دقیقه]
06-03 شرایط خوب = شانس بسیار بهتر! [4 دقیقه]
06-04 سبکهای نوشتن مورد نیاز [3 دقیقه]
06-05 داستانهای کاربر [3 دقیقه]
06-06 الزامات سنتی (مبتنی بر متن) [3 دقیقه]
06-07 موارد استفاده [6 دقیقه]
06-08 انواع نیازها [4 دقیقه]
06-09 مشخصات مورد نیاز نرمافزار (SRS) [4 دقیقه]
06-10 خلاصه و منابع اضافی [2 دقیقه]
07 محصولات تحویلی- طراحی معماری [12 دقیقه]
07-01 مستندات طراحی معماری- یک مرور کلی [1 دقیقه]
07-02 سند طراحی نرمافزار (SDD) [4 دقیقه]
07-03 بخشهای SDD- مقدمه [2 دقیقه]
07-04 بخشهای SDD- معماری سیستم [1 دقیقه]
07-05 بخشهای SDD- طراحی دقیق سیستم [1 دقیقه]
07-06 بخشهای SDD- طراحی داده [1 دقیقه]
07-07 بخشهای SDD- رابط کاربری [1 دقیقه]
07-08 خلاصه [1 دقیقه]
08 موارد تحویلی- مستندات کد [19 دقیقه]
08-01 مستندات کد- یک مرور کلی [1 دقیقه]
08-02 نظرات کد [7 دقیقه]
08-03 اسناد API [3 دقیقه]
08-04 اسناد API- نسخهی نمایشی [4 دقیقه]
08-05 فایلهای README [3 دقیقه]
08-06 خلاصه [1 دقیقه]
09 موارد تحویلی- طرحهای آزمایشی و موارد آزمایشی [16 دقیقه]
09-01 طرحهای آزمایشی و موارد آزمایشی- یک مرور کلی [2 دقیقه]
09-02 طرح تست- یک مثال [7 دقیقه]
09-03 سناریوهای آزمایشی و موارد آزمایشی [1 دقیقه]
09-04 موارد تست نوشتن [4 دقیقه]
09-05 خلاصه و منابع اضافی [2 دقیقه]
10 موارد تحویلی- مستندات کاربر نهایی [15 دقیقه]
10-01 مستندات کاربر نهایی- یک مرور کلی [2 دقیقه]
10-02 راهنمای کاربر [1 دقیقه]
10-03 راهنمای کاربر- یک مثال [5 دقیقه]
10-04 راهنماهای مرجع سریع [2 دقیقه]
10-05 یادداشتهای انتشار [1 دقیقه]
10-06 یادداشتهای انتشار- یک مثال [3 دقیقه]
10-07 خلاصه [1 دقیقه]
11 نتیجه گیری و منابع اضافی [11 دقیقه]
11-01 آغاز پایان [1 دقیقه]
11-02 خلاصه- نگارش فنی و فرآیند نوشتن [2 دقیقه]
11-03 خلاصه- نوشتن بهترین روشها، طرحبندی و طراحی [2 دقیقه]
11-04 خلاصه- موارد قابل تحویل [4 دقیقه]
11-05 پایان داستان [0 دقیقه]
11-06 منابع اضافی [2 دقیقه]
آمبر از اوایل دهه 2000 یک توسعه دهنده نرمافزار و مربی فنی بوده است. او دارای گواهینامههای AWS و انواع فناوریهای مایکروسافت است. در سالهای اخیر، او بر روی AWS، Machine Learning، Azure، Power Apps، Dynamics 365، SharePoint و .NET تمرکز کرده است و به دانشآموزان در سراسر جهان آموزش میدهد. او همچنین برای پر کردن شکاف بین توسعه دهندگان، طراحان و افراد تجاری با تخصص خود در ارتباطات بصری، تجربه کاربر و مهارتهای تجاری/حرفهای تلاش میکند.