پرش به مطلب اصلی

راهنمای استفاده از مستندات آپارات

این راهنما به شما کمک می‌کند تا بهترین استفاده را از مستندات آپارات داشته باشید.

برای چه کسانی؟​

Product Managers​

چه چیزی بخوانند:

  1. فایل‌های Overview هر بخش
  2. بخش Business Rules
  3. KPIs و OKRs
  4. سناریوهای کاربری

چرا مفید است:

  • درک کامل از قابلیت‌های محصول
  • امکان برنامه‌ریزی فیچرهای آینده
  • ارتباط بهتر با تیم‌های دیگر

UX/UI Designers​

چه چیزی بخوانند:

  1. User Flows در سناریوها
  2. نقش‌های مختلف کاربری
  3. Error Handling (برای طراحی پیام‌های خطا)
  4. لینک‌های Figma

چرا مفید است:

  • همسویی طراحی با business logic
  • طراحی UX بهتر با درک کامل سناریوها
  • طراحی consistent برای خطاها

Developers (توسعه‌دهندگان جدید)​

چه چیزی بخوانند:

  1. مرحله ۱ - شروع:

    • README.md اصلی
    • Overview داشبورد کاربر

  2. مرحله ۲ - عمیق‌تر:

    • تمام سناریوهای کاربری
    • Error Handling
    • System Actions

  3. مرحله ۳ - توسعه:

    • API Documentation (پیوست‌ها)
    • Database Schema
    • Flowcharts

چرا مفید است:

  • Onboarding سریع‌تر
  • درک کامل از Business Logic
  • کاهش باگ‌ها و سوءتفاهم‌ها

QA Testers​

چه چیزی بخوانند:

  1. تمام سناریوهای کاربری
  2. بخش Validation در هر سناریو
  3. Error Handling کامل
  4. Edge Cases و محدودیت‌ها

چرا مفید است:

  • نوشتن Test Cases کامل‌تر
  • پیدا کردن باگ‌های edge case
  • بررسی consistency پیام‌های خطا

سناریوهای استفاده​

سناریو ۱: من یک Product Manager جدید هستم​

مسیر یادگیری:

  1. بخوانید: صفحه اصلی
  2. بخوانید: داشبورد کاربر - نمای کلی
  3. مرور کنید: تمام سناریوهای کاربری
  4. نگاهی بیندازید: Figma designs

سناریو ۲: من یک Developer جدید هستم و می‌خواهم feature آپلود ویدئو را توسعه بدهم​

مسیر یادگیری:

  1. بخوانید: داشبورد کاربر - نمای کلی (۱۵ دقیقه)
  2. بخوانید با دقت: سناریو آپلود ویدئو (۴۵ دقیقه)
  3. بخوانید: Error Handling (۳۰ دقیقه)
  4. بخوانید: System Actions (۳۰ دقیقه)
  5. ببینید: Figma Design + Flowchart
  6. شروع به کدنویسی کنید!

سناریو ۳: من یک QA Tester هستم و می‌خواهم Test Case بنویسم​

مسیر کار:

  1. بخوانید: سناریوی مربوطه (مثلاً آپلود ویدئو)
  2. نوت برداری کنید:
    • تمام فیلدها و محدودیت‌هایشان
    • تمام Error Cases
    • تمام Edge Cases
  3. بخوانید: error-handling.md برای لیست کامل خطاها
  4. بنویسید: Test Cases شامل:
    • Happy Path
    • Validation Tests
    • Error Tests
    • Edge Cases

سناریو ۴: من یک Designer هستم و می‌خواهم صفحه آمار را طراحی کنم​

مسیر کار:

  1. بخوانید: سناریو مشاهده آمار
  2. توجه کنید به:
    • نقش‌های مختلف کاربری (هر کدام چه آماری می‌بینند)
    • فیلترها و گزینه‌ها
    • نمودارها
  3. ببینید: Figma (اگر موجود است)
  4. طراحی کنید!
  5. با PM هماهنگ کنید
  6. مستندات را آپدیت کنید (اگر چیزی تغییر کرد)

نکات مهم​

انجام دهید​

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

انجام ندهید​

  • بدون خواندن مستندات شروع به کد نویسی نکنید
  • اگر چیزی تغییر کرد، فراموش نکنید مستندات را آپدیت کنید
  • اطلاعات محرمانه (مثل API Keys) را در مستندات نگذارید
  • بدون هماهنگی با تیم، تغییرات عمده ندهید

FAQ​

مستندات کامل است؟​

خیر، این نسخه اولیه است. به مرور بخش‌های بیشتری اضافه خواهد شد.

چطور می‌توانم به Figma دسترسی داشته باشم؟​

با Lead Designer تماس بگیرید (جزئیات در پیوست‌ها)

آیا مستندات فنی (API) هم هست؟​

فعلاً خیر. API Documentation جداگانه نوشته خواهد شد.

اگر چیزی در مستندات نبود چکار کنم؟​

۱. در Slack بپرسید ۲. با Product Manager هماهنگ کنید ۳. اگر خودتان نوشتید، به مستندات اضافه کنید

نقشه راه آینده​

فاز ۱ (فعلی)​

  • مستندسازی داشبورد کاربر
  • سناریوهای اصلی (آپلود، آمار)
  • Error Handling و System Actions

فاز ۲ (در حال برنامه‌ریزی)​

  • مستندسازی سایر بخش‌های داشبورد:
    • مدیریت لیست‌های پخش
    • تنظیمات کانال
    • مدیریت نظرات
    • درآمدزایی
    • پخش زنده

فاز ۳ (آینده)​

  • API Documentation کامل
  • Database Schema
  • Architecture Diagrams
  • Deployment Guide
  • Troubleshooting Guide

آخرین به‌روزرسانی: ۱۴۰۳/۰۸/۲۶