قالببندی مارکداون با هوش مصنوعی
از روی یادداشتهای پراکنده، یک گزارش خطا یا توضیح تغییرات بنویسید که همکارتون بتونه خلاصه، مراحل و نمونه کد رو راحت پیدا کنه.
قالببندی مارکداون با هوش مصنوعی به درد وقتی میخوره که متن گزارش رو دارید، ولی همکارتون برای پیدا کردن نتیجه باید تا آخرش بخونه. فرض کنید سه خط درباره تغییر فرم ثبتنام نوشتید، وسطش یک دستور گذاشتید و آخرش گفتید چه چیزی رو تست کردید. اسکیل markdown-formatting کمک میکنه تغییر اصلی اول متن بیاد، دستور از توضیح جدا بشه و خواننده بتونه همون بخشی رو بخونه که به کارش مربوطه.
برای یک گزارش خطا، ترتیب دیگهای مناسبتره. کسی که میخواد مشکل رو روی دستگاه خودش ببینه باید بدونه از کجا شروع کنه، چه قدمهایی برداره و در آخر چه چیزی باید ببینه. دو قالب آماده اسکیل برای همین تفاوت به کار میان. میتونید یکی رو به ایجنتتون بدید و ازش بخواید یادداشت فعلی رو در همون قالب مرتب کنه.
کاربردها
- برای توضیح تغییرات، یک خلاصه کوتاه قبل از فهرست کارها بذارید تا بازبین موضوع رو از اول بدونه.
- در گزارش خطا رفتار مورد انتظار و چیزی رو که واقعا رخ داده جدا بنویسید.
- تیترهای مارکداون رو مرتب کنید تا خواننده فرق یک بخش اصلی و زیرعنوان اون رو ببینه.
- زبان هر نمونه کد رو مشخص کنید و اسم فایلها و دستورهای کوتاه رو از متن عادی جدا کنید.
- به جای عبارتی مثل «اینجا»، برای لینک متنی انتخاب کنید که بگه خواننده کدوم راهنما رو باز میکنه.
نصب و استفاده
- اسکیل رو در ایجنتتون باز کنید و پیشنویس رو بدید. برای مرتب کردن متن به حساب یا برنامه جداگانه نیاز ندارید.
- مثلا بگید «این یادداشت رو برای بازبینی تغییرات آماده کن و تستهایی رو که هنوز انجام ندادم جدا بذار».
- خروجی رو بخونید و بررسی کنید که مراحل و نتیجهها با چیزی که خودتون دیدید یکی باشن. بعد متن رو در محل دلخواهتون بذارید.
سوالات متداول
منبع
ساخته Britt Crawford. نام اصلی: markdown-formatting، منتشرشده در GitHub با مجوز MIT.
مشاهده در GitHub