آموزش نگارش فنی: نحوه نوشتن اسناد نرم افزاری

سرفصل ها و درس ها

مقدمه (جدید) Introduction (New)

• معرفی Introduction

مقدمه (جدید) Introduction (New)

• معرفی Introduction

مقدمه ای بر اسناد نرم افزاری (جدید) Introduction to Software Documentation (New)

• ارتباطات فنی Technical Communications

• نوشتن فنی به عنوان یک مهارت Technical Writing as a Skill

• شغل نویسنده فنی The Job of the Technical Writer

• انواع رایج اسناد Common Types of Documentation

• مستندات عملکردی Functional Documentation

• مثال - مستندات عملکردی Example - Functional Documentation

• تمرین: مستندات کاربردی بنویسید Exercise: Write Functional Documentation

• مستندات وظیفه گرا Task Oriented Documentation

• تمرین: مستندات وظیفه گرا بنویسید Exercise: Write Task Oriented Documentation

• جریان فرآیند مستندسازی - خلاصه Documentation Process Flow - Summary

مقدمه ای بر اسناد نرم افزاری (جدید) Introduction to Software Documentation (New)

• نگارش فنی چیست؟ What is Technical Writing?

• نگارش فنی چیست؟ What is Technical Writing?

• ارتباطات فنی Technical Communications

• نوشتن فنی به عنوان یک مهارت Technical Writing as a Skill

• شغل نویسنده فنی The Job of the Technical Writer

• انواع رایج اسناد Common Types of Documentation

• مستندات عملکردی Functional Documentation

• مثال - مستندات عملکردی Example - Functional Documentation

• استراتژی برای نوشتن اسناد عملکردی Strategy for Writing Functional Documentation

• استراتژی برای نوشتن اسناد عملکردی Strategy for Writing Functional Documentation

• تمرین: مستندات کاربردی بنویسید Exercise: Write Functional Documentation

• مستندات وظیفه گرا Task Oriented Documentation

• استراتژی برای نوشتن اسناد وظیفه گرا Strategy for Writing Task Oriented Documentation

• استراتژی برای نوشتن اسناد وظیفه گرا Strategy for Writing Task Oriented Documentation

• تمرین: مستندات وظیفه گرا بنویسید Exercise: Write Task Oriented Documentation

• جریان فرآیند مستندسازی - خلاصه Documentation Process Flow - Summary

نوشتن اسناد نرم افزاری با استفاده از Markdown در GitHub Wiki Writing Software Documentation Using Markdown in GitHub Wiki

• آموزش نوشتن اسناد نرم افزاری با استفاده از Markdown در GitHub Wiki Learn to Write Software Documentation Using Markdown in GitHub Wiki

• نویسندگان فنی در دنیای توسعه نرم افزار Technical Writers in the Software Development World

• GitHub چیست؟ What is GitHub?

• مستندات در GitHub Documentation in GitHub

• یک مخزن جدید در GitHub ایجاد کنید Create a New Repository in GitHub

• آپلود فایل ها و تصاویر Uploading Files and Images

• یک لینک ایمیل ایجاد کنید Create a Mail Link

• فهرست مطالب (TOC) را در ویکی ایجاد کنید Create Table of Contents (TOC) in Wiki

• نگارش ساختاریافته در محیط ویکی گیت هاب Structured Writing in GitHub Wiki Environment

• چه چیزی یاد خواهید گرفت؟ What will you learn?

• چرا در نوشتن به ساختار نیاز داریم؟ Why do we Need Structure in Writing?

• UX سازگار Consistent UX

• تجربه شهودی Intuitive Experience

• کامل بودن مستندات Completeness of Documentation

• هدف گذاری محتوا Targeting Content

• هماهنگی پروژه ها Projects Coordination

• بهره وری Efficiency

• انواع اطلاعات رایج Common Information Types

• استاندارد DITA XML DITA XML Standard

• نگارش ساختاریافته در GitHub Wiki Structured Writing in GitHub Wiki

• نمونه های مربی Instructor Examples

• الگوها - توضیح داده شده - وظیفه و مفهوم Templates - Explained - Task and Concept

• الگوها - توضیح داده شده - مرجع Templates - Explained - Reference

• نسخه ی نمایشی Demo

• نمونه کار از دانش آموزان: ملودی Example work from students: Melody

• نمونه کار از دانش آموزان: امیلی Example work from students: Emily

نوشتن اسناد نرم افزاری با استفاده از Markdown در GitHub Wiki Writing Software Documentation Using Markdown in GitHub Wiki

• آموزش نوشتن اسناد نرم افزاری با استفاده از Markdown در GitHub Wiki Learn to Write Software Documentation Using Markdown in GitHub Wiki

• نویسندگان فنی در دنیای توسعه نرم افزار Technical Writers in the Software Development World

• تحویل فنی نگارش در دنیای توسعه نرم افزار Technical Writing Deliverables in the Software Development World

• تحویل فنی نگارش در دنیای توسعه نرم افزار Technical Writing Deliverables in the Software Development World

• GitHub چیست؟ What is GitHub?

• چرا GitHub؟ Why GitHub?

• چرا GitHub؟ Why GitHub?

• مستندات در GitHub Documentation in GitHub

• زبان نشانه گذاری Markup Language

• زبان نشانه گذاری Markup Language

• نمونه های مربی Instructor Examples

• تمرینات در این بخش دوره Exercises in This Course Section

• تمرینات در این بخش دوره Exercises in This Course Section

• یک مخزن جدید در GitHub ایجاد کنید Create a New Repository in GitHub

• نسخه ی نمایشی: ایجاد یک صفحه ویکی جدید و قالب بندی اولیه Demo: Creating a New Wiki Page and Basic Formatting

• نسخه ی نمایشی: ایجاد یک صفحه ویکی جدید و قالب بندی اولیه Demo: Creating a New Wiki Page and Basic Formatting

• یک جدول در GitHub ایجاد کنید Create a Table in GitHub

• یک جدول در GitHub ایجاد کنید Create a Table in GitHub

• آپلود فایل ها و تصاویر Uploading Files and Images

• یک لینک ایمیل ایجاد کنید Create a Mail Link

• فهرست مطالب (TOC) را در ویکی ایجاد کنید Create Table of Contents (TOC) in Wiki

• یک پیوند به ویدیوی YouTube ایجاد کنید Create a Link to YouTube Video

• یک پیوند به ویدیوی YouTube ایجاد کنید Create a Link to YouTube Video

• نسخه ی نمایشی Demo

• نگارش ساختاریافته در محیط ویکی گیت هاب Structured Writing in GitHub Wiki Environment

• چه چیزی یاد خواهید گرفت؟ What will you learn?

• چرا در نوشتن به ساختار نیاز داریم؟ Why do we Need Structure in Writing?

• سازماندهی محتوا Organize Content

• سازماندهی محتوا Organize Content

• UX سازگار Consistent UX

• تجربه شهودی Intuitive Experience

• کامل بودن مستندات Completeness of Documentation

• هدف گذاری محتوا Targeting Content

• هماهنگی پروژه ها Projects Coordination

• بهره وری Efficiency

• نگارش ساختاریافته - تعریف Structured Writing - Definition

• نگارش ساختاریافته - تعریف Structured Writing - Definition

• انواع اطلاعات رایج Common Information Types

• استاندارد DITA XML DITA XML Standard

• چگونه در یک محیط نوشتاری بدون ساختار ساختاربندی کنیم؟ How to Structure in an Unstructured Writing Environment?

• چگونه در یک محیط نوشتاری بدون ساختار ساختاربندی کنیم؟ How to Structure in an Unstructured Writing Environment?

• نگارش ساختاریافته در GitHub Wiki Structured Writing in GitHub Wiki

• نمونه های مربی Instructor Examples

• نمونه های مربی Instructor Examples

• الگوها - توضیح داده شده - وظیفه و مفهوم Templates - Explained - Task and Concept

• الگوها - توضیح داده شده - مرجع Templates - Explained - Reference

• نسخه ی نمایشی Demo

• نسخه ی نمایشی Demo

• ایده هایی برای سازماندهی نمونه کارها Ideas for Organizing Your Own Portfolio

• ایده هایی برای سازماندهی نمونه کارها Ideas for Organizing Your Own Portfolio

• نمونه کار از دانش آموزان: ملودی Example work from students: Melody

• نمونه کار از دانش آموزان: آلیس Example work from students: Alice

• نمونه کار از دانش آموزان: آلیس Example work from students: Alice

• نمونه کار از دانش آموزان: مارینا Example work from students: Marina

• نمونه کار از دانش آموزان: مارینا Example work from students: Marina

• نمونه کار از دانش آموزان: امیلی Example work from students: Emily

• نمونه کار از دانش آموزان: مارتا Example work from students: Marta

• نمونه کار از دانش آموزان: مارتا Example work from students: Marta

گرافیک در اسناد نرم افزاری (جدید) Graphics in Software Documentation (New)

• گرافیک در اسناد نرم افزاری Graphics in Software Documentation

• ابزارهایی برای ایجاد گرافیک Tools for Creating Graphics

گرافیک در اسناد نرم افزاری (جدید) Graphics in Software Documentation (New)

• قبل از اینکه شروع کنیم... Before We Start...

• قبل از اینکه شروع کنیم... Before We Start...

• گرافیک در اسناد نرم افزاری Graphics in Software Documentation

• چه زمانی از گرافیک استفاده کنیم؟ When to Use Graphics?

• چه زمانی از گرافیک استفاده کنیم؟ When to Use Graphics?

• انواع گرافیک در اسناد نرم افزاری Types of Graphics in Software Documentation

• انواع گرافیک در اسناد نرم افزاری Types of Graphics in Software Documentation

• ابزارهایی برای ایجاد گرافیک Tools for Creating Graphics

• مایکروسافت پاورپوینت Microsoft PowerPoint

• مایکروسافت پاورپوینت Microsoft PowerPoint

• diagrams.net diagrams.net

• diagrams.net diagrams.net

• canva.com canva.com

• canva.com canva.com

مبانی معماری اطلاعات (جدید) Information Architecture Basics (New)

• معماری اطلاعات برای نویسندگان فنی Information Architecture for Technical Writers

• تجربه کاربری (UX) و معماری اطلاعات در نگارش فنی User Experience (UX) and Information Architecture in Technical Writing

• کالاهای تحویلی و کانال های تحویل Deliverables and Delivery Channels

• پژوهش Research

• تحویل Delivery

• با استفاده از داده ها Using the Data

• مرتب سازی کارت چیست؟ What is Card Sorting?

• مزایای تکنیک مرتب سازی کارت Benefits of the Card Sorting Technique

• باز کردن مرتب سازی کارت Open Card Sorting

• مثال دوم مربی Instructor's Second Example

• دسته بندی کارت های بسته Closed Cards Sorting

• مثال مربی Instructor's Example

• نقاشی دیواری به عنوان ابزاری برای مرتب سازی کارت ها Mural as a Tool for Cards Sorting

مبانی معماری اطلاعات (جدید) Information Architecture Basics (New)

• معماری اطلاعات برای نویسندگان فنی Information Architecture for Technical Writers

• در این بخش چه خواهید آموخت؟ What Will You Learn in This Section?

• در این بخش چه خواهید آموخت؟ What Will You Learn in This Section?

• معماری اطلاعات چیست؟ What is Information Architecture?

• معماری اطلاعات چیست؟ What is Information Architecture?

• تجربه کاربری (UX) و معماری اطلاعات در نگارش فنی User Experience (UX) and Information Architecture in Technical Writing

• تحقیق و تحلیل کاربران User Research and Analysis

• تحقیق و تحلیل کاربران User Research and Analysis

• شناخت کاربر Knowing the User

• شناخت کاربر Knowing the User

• کالاهای تحویلی و کانال های تحویل Deliverables and Delivery Channels

• پژوهش Research

• تحویل Delivery

• مدل سازی محتوا Content Modeling

• مدل سازی محتوا Content Modeling

• با استفاده از داده ها Using the Data

• استفاده از مرتب سازی کارت ها در تحقیقات کاربر Using Cards Sorting in User Research

• استفاده از مرتب سازی کارت ها در تحقیقات کاربر Using Cards Sorting in User Research

• مرتب سازی کارت چیست؟ What is Card Sorting?

• مزایای تکنیک مرتب سازی کارت Benefits of the Card Sorting Technique

• باز کردن مرتب سازی کارت Open Card Sorting

• چگونه آن را تنظیم کنیم؟ How to Set it Up?

• چگونه آن را تنظیم کنیم؟ How to Set it Up?

• نسخه ی نمایشی: باز کردن مرتب سازی کارت با استفاده از نقاشی دیواری Demo: Open Card Sorting Using Mural

• نسخه ی نمایشی: باز کردن مرتب سازی کارت با استفاده از نقاشی دیواری Demo: Open Card Sorting Using Mural

• مثال دوم مربی Instructor's Second Example

• دسته بندی کارت های بسته Closed Cards Sorting

• چگونه آن را تنظیم کنیم؟ نسخه ی نمایشی در نقاشی دیواری How to Set it up? Demo in Mural

• چگونه آن را تنظیم کنیم؟ نسخه ی نمایشی در نقاشی دیواری How to Set it up? Demo in Mural

• مثال مربی Instructor's Example

• نقاشی دیواری به عنوان ابزاری برای مرتب سازی کارت ها Mural as a Tool for Cards Sorting

کیفیت در اسناد نرم افزاری Quality in Software Documentation

• تعریفی از "کیفیت" A Definition of "Quality"

• تحقیق The Research

• چارچوب - بررسی اجمالی The Framework - Overview

• مفید است Helpful

• جامع Comprehensive

• دیداری Visual

• در دسترس Accessible

• استفاده از لحن مناسب Using Appropriate Tone

کیفیت در اسناد نرم افزاری Quality in Software Documentation

• تعریف معنای کیفیت در مستندسازی Defining the Meaning of Quality in Documentation

• تعریف معنای کیفیت در مستندسازی Defining the Meaning of Quality in Documentation

• چه چیزی یاد خواهید گرفت؟ What Will You Learn?

• چه چیزی یاد خواهید گرفت؟ What Will You Learn?

• تعریفی از "کیفیت" A Definition of "Quality"

• "کیفیت" در اسناد نرم افزار چیست؟ What is "Quality" in Software Documentation?

• "کیفیت" در اسناد نرم افزار چیست؟ What is "Quality" in Software Documentation?

• تحقیق The Research

• نتایج The Results

• نتایج The Results

• مردم چه جوابی دادند؟ What Did People Answer?

• مردم چه جوابی دادند؟ What Did People Answer?

• چارچوب - بررسی اجمالی The Framework - Overview

• مفید است Helpful

• جامع Comprehensive

• قابل جستجو Searchable

• قابل جستجو Searchable

• دیداری Visual

• قابل استفاده Usable

• قابل استفاده Usable

• قابل اعتماد Reliable

• قابل اعتماد Reliable

• از نظر گرامری درست است Grammatically Correct

• از نظر گرامری درست است Grammatically Correct

• قابل ترجمه و بومی سازی دوستانه Translatable and Localization Friendly

• قابل ترجمه و بومی سازی دوستانه Translatable and Localization Friendly

• در دسترس Accessible

• استفاده از لحن مناسب Using Appropriate Tone

• چگونه از نتایج تحقیق استفاده کنیم؟ How to Use the Results from the Research?

• چگونه از نتایج تحقیق استفاده کنیم؟ How to Use the Results from the Research?

سخنرانی جایزه: مواد اضافی Bonus Lecture: Additional Materials

• راهنمای سبک چیست؟ What is Style Guide?

• چرا برای نوشتن به استانداردهایی نیاز داریم؟ Why do we Needs Standards for Writing?

• نتایج استفاده از راهنمای سبک Results from Using a Style Guide

• دقت، درستی Precision

• انتخاب فعل: می توانم یا می؟ Verb Choice: Can or May?

• انتخاب فعل: باید/نباید/باید/نباید/می Verb Choice: Must/Must not/Should/Shouldn't/May

• سیستم های مدیریت محتوا (CMS) Content Management Systems (CMS)

• استانداردها و رهنمودهای نوشتن Writing Standards and Guidelines

• پاسخ وبینار: محتوای هدف برای کاربران Webinar Reply: Targeting Content for Users

سخنرانی جایزه: مواد اضافی Bonus Lecture: Additional Materials

• نحوه استفاده از راهنمای سبک در نگارش فنی How to Use a Style Guide in Technical Writing

• نحوه استفاده از راهنمای سبک در نگارش فنی How to Use a Style Guide in Technical Writing

• راهنمای سبک چیست؟ What is Style Guide?

• چرا برای نوشتن به استانداردهایی نیاز داریم؟ Why do we Needs Standards for Writing?

• نمونه راهنماهای سبک Sample Style Guides

• نمونه راهنماهای سبک Sample Style Guides

• 3 نمونه راهنماهای سبک 3 Sample Style Guides

• 3 نمونه راهنماهای سبک 3 Sample Style Guides

• چه کسی دیگر برای نوشتن به قوانین نیاز دارد؟ Who Else Needs Rules for Writing?

• چه کسی دیگر برای نوشتن به قوانین نیاز دارد؟ Who Else Needs Rules for Writing?

• نتایج استفاده از راهنمای سبک Results from Using a Style Guide

• ساختار در نوشتار Structure in Writing

• ساختار در نوشتار Structure in Writing

• مختصر بودن Conciseness

• مختصر بودن Conciseness

• سادگی Simplicity

• سادگی Simplicity

• دقت، درستی Precision

• انتخاب فعل: می توانم یا می؟ Verb Choice: Can or May?

• انتخاب فعل: باید/نباید/باید/نباید/می Verb Choice: Must/Must not/Should/Shouldn't/May

• صدای فعال و زمان حال Active Voice and Present Tense

• صدای فعال و زمان حال Active Voice and Present Tense

• واژه شناسی Terminology

• واژه شناسی Terminology

• علاوه بر این در نظر بگیرید Consider in Addition

• علاوه بر این در نظر بگیرید Consider in Addition

• از ابزار استفاده کنید! Use Tools!

• از ابزار استفاده کنید! Use Tools!

• پیام‌های رابط کاربری و متن روی صفحه UI Messages and Text on Screen

• پیام‌های رابط کاربری و متن روی صفحه UI Messages and Text on Screen

• ورزش Exercise

• ورزش Exercise

• سیستم های مدیریت محتوا (CMS) Content Management Systems (CMS)

• استانداردها و رهنمودهای نوشتن Writing Standards and Guidelines

• پاسخ وبینار: محتوای هدف برای کاربران Webinar Reply: Targeting Content for Users

• پاسخ وبینار: محتوای هدف برای کاربران - قسمت 2 Webinar Reply: Targeting Content for Users - Part 2

• پاسخ وبینار: محتوای هدف برای کاربران - قسمت 2 Webinar Reply: Targeting Content for Users - Part 2

• پخش وبینار: مبانی نگارش ساختاریافته Webinar Replay: Basics of Structured Writing

• پخش وبینار: مبانی نگارش ساختاریافته Webinar Replay: Basics of Structured Writing