آموزش نگارش فنی: مستندات مربوط به پروژه های نرم افزاری

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

بررسی اجمالی دوره Course Overview

• بررسی اجمالی دوره Course Overview

مقدمه ای بر نگارش فنی Introduction to Technical Writing

• بذار بهت یک قصه بگم... Let Me Tell You a Story...

• اما من یک توسعه دهنده هستم ، نه یک نویسنده ... But I’m a Developer, Not a Writer...

• چرا نوشتن فنی مهم است (حتی برای توسعه دهندگان) Why Technical Writing Is Important (Even for Developers)

• نگارش فنی: یک نمای کلی Technical Writing: An Overview

• طرح کلی دوره و پیش نیازها Course Outline and Prerequisites

روند نوشتن The Writing Process

• روند نوشتن: مروری کلی The Writing Process: An Overview

• مرحله برنامه ریزی: هدف The Planning Phase: Purpose

• مرحله برنامه ریزی: مخاطبان The Planning Phase: Audience

• مرحله برنامه ریزی: تحویل The Planning Phase: Delivery

• مرحله تحقیق The Research Phase

• مرحله نوشتن The Writing Phase

• مرحله بازبینی/ویرایش The Reviewing/Editing Phase

• مرحله راه اندازی The Launch Phase

• خلاصه Summary

نکات نوشتاری و بهترین روش ها Writing Tips and Best Practices

• نکات نوشتاری و بهترین روش ها: یک مرور کلی Writing Tips and Best Practices: An Overview

• دقت Accuracy

• وضوح Clarity

• خلاصه Conciseness

• لحن Tone

• زمان فعل Tense

• دستور زبان ، هجی و اصطلاحات Grammar, Spelling, and Terminology

• منابع خلاصه و اضافی Summary and Additional Resources

چیدمان و طراحی Layout and Design

• چیدمان و طراحی: یک نمای کلی Layout and Design: An Overview

• تایپوگرافی: مبانی Typography: The Basics

• تایپوگرافی: رهنمودها Typography: Guidelines

• اصول طراحی: یک نمای کلی Design Principles: An Overview

• هم ترازی Alignment

• مجاورت Proximity

• تضاد Contrast

• فضای سفید Whitespace

• عناصر طراحی صفحه Page Design Elements

• تصویری Visuals

• خلاصه Summary

تحویل پذیر: الزامات Deliverables: Requirements

• مورد نیاز: یک نمای کلی Requirements: An Overview

• شرایط ضعیف = شکست پروژه Poor Requirements = Project Failure

• شرایط خوب = احتمال خیلی بهتر! Good Requirements = Much Better Chance!

• سبک های نوشتاری مورد نیاز Requirement Writing Styles

• داستان های کاربر User Stories

• الزامات سنتی (مبتنی بر متن) Traditional (Text-based) Requirements

• از موارد استفاده کنید Use Cases

• انواع الزامات Types of Requirements

• مشخصات مورد نیاز نرم افزار (SRS) Software Requirements Specification (SRS)

• منابع خلاصه و اضافی Summary and Additional Resources

تحویل پذیر: طراحی/معماری Deliverables: Design/Architecture

• مستندات طراحی/معماری: یک نمای کلی Design/Architecture Documentation: An Overview

• سند طراحی نرم افزار (SDD) Software Design Document (SDD)

• بخشهای SDD: مقدمه SDD Sections: Introduction

• بخشهای SDD: معماری سیستم SDD Sections: System Architecture

• بخشهای SDD: طراحی دقیق سیستم SDD Sections: Detailed System Design

• بخشهای SDD: طراحی داده ها SDD Sections: Data Design

• بخشهای SDD: رابط کاربری SDD Sections: User Interface

• خلاصه Summary

تحویل پذیر: مستندات کد Deliverables: Code Documentation

• مستندات کد: یک نمای کلی Code Documentation: An Overview

• نظرات کد Code Comments

• مستندات API API Documentation

• مستندات API: نسخه ی نمایشی API Documentation: Demo

• فایلها را دوباره بخوانید README Files

• خلاصه Summary

تحویل پذیر: برنامه های آزمایشی و موارد آزمایشی Deliverables: Test Plans and Test Cases

• برنامه های آزمایشی و موارد آزمایشی: یک نمای کلی Test Plans and Test Cases: An Overview

• طرح آزمون: یک نمونه Test Plan: An Example

• سناریوهای آزمون و موارد آزمایشی Test Scenarios and Test Cases

• نوشتن موارد آزمون Writing Test Cases

• منابع خلاصه و اضافی Summary and Additional Resources

تحویل پذیر: مستندات کاربر نهایی Deliverables: End-user Documentation

• مستندات کاربر نهایی: یک نمای کلی End-user Documentation: An Overview

• راهنمای استفاده User Guides

• راهنماهای کاربر: یک مثال User Guides: An Example

• راهنماهای مرجع سریع Quick Reference Guides

• یادداشت ها را منتشر کنید Release Notes

• یادداشت های انتشار: یک مثال Release Notes: An Example

• خلاصه Summary

نتیجه گیری و منابع اضافی Conclusion and Additional Resources

• شروع یک پایان The Beginning of the End

• خلاصه: نگارش فنی و روند نوشتن Recap: Technical Writing and the Writing Process

• خلاصه مطالب: نوشتن بهترین شیوه ها ، طرح بندی و طراحی Recap: Writing Best Practices, Layout, and Design

• خلاصه: تحویل پذیر Recap: Deliverables

• پایان داستان The End of the Story

• منابع اضافی Additional Resources