3.4 KiB
3.4 KiB
شیوهنامهٔ نگارش فنی و استانداردهای کوئرا کالج
دورهٔ وایب کدینگ (Vibe Coding)
این شیوهنامه استانداردهای زبانی، ساختاری و بصری درسنامههای متنی و تمرینهای دوره را مشخص میکند.
۱. لحن و زبان نگارش (Tone & Voice)
- مخاطب دوره: افراد بدون پیشزمینهٔ کدنویسی (طراحان، مدیران محصول، کارآفرینان، بازاریابها و علاقهمندان).
- لحن: صمیمی، حرفهای، تشویقکننده، شفاف و بدون اصطلاحات پیچیدهٔ غیرضروری.
- رعایت نیمفاصلهها: در تمام متون فارسی، نیمفاصله برای پیشوندها و پسوندها (مانند «میشود»، «درسنامه»، «ایجنتها»، «راهاندازی») الزامی است.
- اصطلاحات فنی: اصطلاحات کلیدی (مثل Token, Context Window, Prompt, Agent, Git, Repository, PRD, MVP, Mock Data, Supabase) در اولین اشاره به همراه معادل انگلیسی درون پرانتز یا پاورقی آورده شوند.
۲. ساختار استاندارد درسنامههای کوئرا (Lesson Anatomy)
هر درسنامه متنی باید ساختار زیر را رعایت کند:
- مقدمه و قلاب (Hook): یک موقعیت واقعی، مسئله یا چالش روزمره که ضرورت این موضوع را نشان میدهد.
- شرح مفهوم به زبان ساده (Core Concept): توضیح اصل موضوع بدون پرداختن به جزییات زائد. استفاده از استعارهها و نمودارهای بصری (Mermaid).
- جعبههای راهنما و هشدار (Admonitions):
> [!NOTE]برای نکات تکمیلی و پسزمینه> [!TIP]برای ترفندها و پرامپتهای طلایی> [!IMPORTANT]برای ملزومات کلیدی> [!WARNING]برای اشتباهات رایج و توهمهای هوش مصنوعی (AI Hallucinations)
- جعبه پرامپت نمونه (Ready-to-Use Prompt): پرامپتهای کپی-پیست آماده برای ادیتورهایی مثل Cursor/Claude Code.
- جمعبندی و گام بعدی (Summary & Action Item): خلاصه در ۳-۴ بالت پوینت کوتاه به همراه پیشنمایش درس بعدی.
۳. استاندارد تمرینهای داوری خودکار (Judge Problems)
- داستانپردازی بومی (Iranian Startup Scenarios): تمرینها حول مسائل واقعی استارتاپها (اسنپفود، دیوار، طاقچه، دیجیکالا، فیلیمو، علیبابا، تپسی، شیپور، پونیشا، والکس، بازار، ویرگول، آپارات، جابینجا) طراحی میشوند.
- وضوح خروجی: دانشجو باید دقیقاً بداند چه فایلهایی با چه ساختاری و چه فرمتی از او خواسته شده است.
- پیامهای خطای آموزشی: تستهای داور خودکار باید خطاهای شفاف تولید کنند تا دانشجو با ارائهٔ همان خطا به هوش مصنوعی بتواند کد را دیباگ کند.