وب سایت تخصصی شرکت فرین
دسته بندی دوره ها

Technical Writing: Documentation on Software Projects

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

This course covers the fundamentals of writing effective software documentation. Whether you need to document requirements, architecture/design, code, test plans, or manuals for end users, this course gives you tips and best practices to do it all.


1. Course Overview
  • 1. Course Overview

  • 2. Introduction to Technical Writing
  • 1. Let Me Tell You a Story...
  • 2. But Im a Developer, Not a Writer...
  • 3. Why Technical Writing Is Important (Even for Developers)
  • 4. Technical Writing - An Overview
  • 5. Course Outline and Prerequisites

  • 3. The Writing Process
  • 1. The Writing Process - An Overview
  • 2. The Planning Phase - Purpose
  • 3. The Planning Phase - Audience
  • 4. The Planning Phase - Delivery
  • 5. The Research Phase
  • 6. The Writing Phase
  • 7. The ReviewingEditing Phase
  • 8. The Launch Phase
  • 9. Summary

  • 4. Writing Tips and Best Practices
  • 1. Writing Tips and Best Practices - An Overview
  • 2. Accuracy
  • 3. Clarity
  • 4. Conciseness
  • 5. Tone
  • 6. Tense
  • 7. Grammar, Spelling, and Terminology
  • 8. Summary and Additional Resources

  • 05. Layout and Design
  • 01. Layout and Design - An Overview
  • 02. Typography - The Basics
  • 03. Typography - Guidelines
  • 04. Design Principles - An Overview
  • 05. Alignment
  • 06. Proximity
  • 07. Contrast
  • 08. Whitespace
  • 09. Page Design Elements
  • 10. Visuals
  • 11. Summary

  • 06. Deliverables - Requirements
  • 01. Requirements - An Overview
  • 02. Poor Requirements = Project Failure
  • 03. Good Requirements = Much Better Chance!
  • 04. Requirement Writing Styles
  • 05. User Stories
  • 06. Traditional (Text-based) Requirements
  • 07. Use Cases
  • 08. Types of Requirements
  • 09. Software Requirements Specification (SRS)
  • 10. Summary and Additional Resources

  • 7. Deliverables - DesignArchitecture
  • 1. DesignArchitecture Documentation - An Overview
  • 2. Software Design Document (SDD)
  • 3. SDD Sections - Introduction
  • 4. SDD Sections - System Architecture
  • 5. SDD Sections - Detailed System Design
  • 6. SDD Sections - Data Design
  • 7. SDD Sections - User Interface
  • 8. Summary

  • 8. Deliverables - Code Documentation
  • 1. Code Documentation - An Overview
  • 2. Code Comments
  • 3. API Documentation
  • 4. API Documentation - Demo
  • 5. README Files
  • 6. Summary

  • 9. Deliverables - Test Plans and Test Cases
  • 1. Test Plans and Test Cases - An Overview
  • 2. Test Plan - An Example
  • 3. Test Scenarios and Test Cases
  • 4. Writing Test Cases
  • 5. Summary and Additional Resources

  • 10. Deliverables - End-user Documentation
  • 1. End-user Documentation - An Overview
  • 2. User Guides
  • 3. User Guides - An Example
  • 4. Quick Reference Guides
  • 5. Release Notes
  • 6. Release Notes - An Example
  • 7. Summary

  • 11. Conclusion and Additional Resources
  • 1. The Beginning of the End
  • 2. Recap - Technical Writing and the Writing Process
  • 3. Recap - Writing Best Practices, Layout, and Design
  • 4. Recap - Deliverables
  • 5. The End of the Story
  • 6. Additional Resources
  • 139,000 تومان
    بیش از یک محصول به صورت دانلودی میخواهید؟ محصول را به سبد خرید اضافه کنید.
    افزودن به سبد خرید
    خرید دانلودی فوری

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

    ایمیل شما:
    تولید کننده:
    مدرس:
    شناسه: 6418
    حجم: 511 مگابایت
    مدت زمان: 228 دقیقه
    تاریخ انتشار: ۳ اسفند ۱۴۰۱
    طراحی سایت و خدمات سئو

    139,000 تومان
    افزودن به سبد خرید