Сайн баг репорт хэрхэн бичих вэ (AI эсвэл хөгжүүлэгчид зориулсан)

Сайн баг репорт нь өөр хүн — хөгжүүлэгч эсвэл AI — танаас ямар ч асуулт асуулгүйгээр яг адилхан асуудлыг харах боломжийг олгодог. Тодорхой гарчиг, дахин үүсгэх яг алхмууд, юу хүлээснээ, юу бодитоор болсон, алдааны мессежийг үгээр нь хуулж, хаана болсон — ямар хуудас, хөтөч, төхөөрөмж, хэрэглэгч гэдгийг — хэрэгтэй. Нэг репортод нэг алдаа, хэрэв тусалбал дэлгэцийн зурагтай байг.

Ихэнх алдааг ойлгоход засахаас илүү удаан зарцуулдаг. Сайн репорт ойлгох хэсгийг арилгадаг. Энэ нь AI хэрэгслүүдэд ялангуяа чухал: AI "checkout бүдүүлэг байна" гэдэг нь юуг хэлснийг дахин асуух боломжгүй тул таамаглах бөгөөд буруу таамаглал өөр зүйлийг эвдэж болно.

Загвар

Энийг хуулж аваад бөглө:

Гарчиг: [Юу буруу байна, хаана] — жишээ нь "Захиалгын форм 18:00-ийн дараах цагийг татгалзана"

Дахин үүсгэх алхмууд:
1. ...
2. ...
3. ...

Хүлээсэн: [юу болох ёстой байсан]
Бодит: [оронд нь юу болсон]

Алдааны мессеж: [яг текст, байвал]
Хаана: [хуудас/URL, хөтөч, төхөөрөмж, ямар хэрэглэгчээр нэвтэрсэн]
Хэр олон удаа: [яг үргэлж / заримдаа / нэг удаа]
Дэлгэцийн зураг эсвэл бичлэг: [хавсаргасан]

Эрэмбэ бүрийг энэ гарын авлага тайлбарлана.

Алхам 1: Эхлээд дахин үүсгэ

Бичихийн өмнө алдааг дахин гаргаж үзээрэй. Ямар алхам чухал, үргэлж болдог эсэхийг мэдэх болно.

Цэвэр төлөвөөс эхэл: шинэчил, эсвэл гарч, дахин нэвтэр.
Алхам бүрийг, бичсэн бүх зүйлийг тэмдэглэ.
Үүнийг үүсгэдэг хамгийн богино замыг ол.
Өөр хөтөч эсвэл дансаар туршаарай. Зөвхөн нэг хэрэглэгчид гарч байвал энэ чухал дохио.

Энэ тухай илүү мэдэхийг хүсвэл AI-ээр бүтээсэн аппыг хэрхэн дебаг хийх вэ гэдгийг үз.

Алхам 2: Тодорхой гарчиг бич

Гарчиг нь юу буруу, хаана вэ гэдгийг хэлэх ёстой, ингэснээр жагсаалтыг харсан хүн аль алдаа вэ гэдгийг мэднэ.

Сул	Хүчтэй
Checkout эвдэрсэн	Сагсанд хөнгөлөлтийн код байхад checkout товч ямар ч үйлдэл хийдэггүй
Мобайлын асуудал	400px-ээс бага утастай дээр үнийн карт дэлгэцээс хэтэрдэг
Хадгалахад алдаа	Нэрэндээ эможи агуулсан профайлыг хадгалахад "500 Internal Server Error" гарна

Алхам 3: Яг алхмуудыг жагсаа

Дугаарла. Үгчлэн бич: аль хуудас, аль товч, юу бичсэн.

Харилцагчийн туршилтын дансаар нэвтэр (customer@example.com).
"Starter kit"-ийг сагсанд нэм.
WELCOME10 хөнгөлөлтийн кодыг оруулаад Apply дарна.
Checkout дарна.

"Кодтой checkout хийж үз" гэвэл ихэвчлэн чухал байдаг нарийн мэдээллийг орхидог: аль хэрэглэгч, аль бүтээгдэхүүн, аль код, эхлээд хэрэглэсэн эсэх.

Алхам 4: Хүлээсэн ба бодит

Энэ бол репортын гол хэсэг. Хоёуланг нь хэл, учир нь ялгаа нь алдаа мөн.

Хүлээсэн: Checkout хуудас нийт дүн дээр 10% хөнгөлөлттэйгээр нээгдэнэ.
Бодит: Товч секундын турш эргэлдэж, дараа нь юу ч болохгүй. Кодгүйгээр checkout ажилладаг.

"Хүлээсэн"-гүйгээр уншигч аашийг буруу гэдгийг мэдэхгүй байж магадгүй. "Бодит"-гүйгээр юуг хайхаа мэдэхгүй.

Алхам 5: Алдааг яг хуул

Алдааны мессеж нь шалтгааныг олох хамгийн хурдан зам. Үгчлэн хуул, парафраз хийж бүү бич.

Хаанаас олох вэ:

Дэлгэц дээр: аппын харуулсан аливаа мессеж.
Хөтөчийн консол: хөгжүүлэгчийн хэрэгслийг нээ (F12, эсвэл хулганы баруун товч → Inspect) ба Console табыг хар — улаан мөрүүд.
Network таб: хөгжүүлэгчийн хэрэгслийн дотор алдаатай хүсэлтийг ол, түүний URL болон статус кодыг тэмдэглэ (жишээ нь POST /api/checkout → 500).
Серверийн лог, хэрвээ танд хандалт байвал.

Дараах мөр, жишээ нь TypeError: Cannot read properties of undefined (reading 'percent') at checkout.ts:48, шууд асуудлын үндэс рүү заах нь олонтоо.

Алхам 6: Контекст нэм

Хаана: хуудасны URL, орчин (урьдчилан харах, staging эсвэл бодит).
Хэн: ямар хэрэглэгч эсвэл үүрэг — админ, гишүүн, нэвтрээгүй.
Төхөөрөмж ба хөтөч: "iPhone дээрх Safari" ба "Windows дээрх Chrome" ялгаатай байж болно.
Өгөгдөл: бичлэгийн талаар ер бусын зүйл — маш урт текст, тусгай тэмдэгт, олон зүйл.
Хэзээ эхэлсэн: "өчигдрийн хөнгөлөлтийн кодын өөрчлөлтийн дараа" бол маш ашигтай.
Хэр олон удаа: үргэлж, эсвэл арван оролдлогын нэг.

Алхам 7: Харуул

Асуудлыг дугуйлсан дэлгэцийн зураг эсвэл богино дэлгэцийн бичлэг нь ялангуяа байрлалын алдаанд эргэлзээг арилгадаг. Таны AI хэрэгсэл зураг хүлээн авдаг бол хавсаргаарай. Хувийн мэдээллийг, түлхүүр болон бусдын өгөгдлийг зурагнаас тайраарай.

AI бүтээгчид баг репорт бичих

Ижил бүтэц промпт болдог. Хоёр нэмэлт тус болдог:

Юу өөрчлөгдөж болохгүйг хэл, ингэснээр засвар шинэ асуудал үүсгэхгүй.
Засвараа шалгахыг хүс, зөвхөн бичихийг биш.

Харилцагчаар нэвтэрч, "Starter kit"-ийг сагсанд хийж, WELCOME10 кодыг хэрэглэсэн үед Checkout дарахад юу ч болохгүй. Хүлээсэн: 10% хөнгөлөлттэй checkout хуудас нээгдэнэ. Бодит: богино эргэлт, дараа нь юу ч биш. Network таб POST /api/checkout 500 буцаасныг харуулж байна. Кодгүй checkout ажилладаг. Шалтгааныг ол, мөн хувь хэмжээний код, тогтмол дүнгийн код, код байхгүй гэсэн тохиолдлуудад үнийн тооцоололд хүрэхгүйгээр засаарай. Дараа нь эдгээр гурвыг шалгаарай.

Хэрвээ шалтгаанд эргэлзэж байвал эхлээд оношлогоо асуу:

Одоо код бүү өөрчил. Энэ репорт дээр үндэслэн, аль шалтгаан магадгүй вэ, мөн тус бүрийг юу баталгаажуулах вэ?

Түгээмэл алдаанууд

"Энэ эвдэрсэн." Алхам байхгүй, хүлээсэн үр дүн байхгүй — юу ч хийх зүйлгүй.
Нэг репортод хэд хэдэн алдаа. Зарим нь засагдана, зарим нь алдагдана.
Парафраз хийсэн алдаа. "Ямар нэг undefined зүйл" гэвэл хэрэгтэй хэсэг нуугдана.
Хэрэглэгч эсвэл үүргийг орхих. Олон алдаа зөвхөн админд, эсвэл зөвхөн шинэ хэрэглэгчид гардаг.
Зөвхөн хүссэн засварыг дүрслэх ("null шалгалт нэм") асуудлыг биш.
Нууц мэдээлэл хуваалцах дэлгэцийн зураг эсвэл хуулсан логт.

Шалгах жагсаалт

Би алдааг дахин үүсгэж, хамгийн богино алхмуудыг олсон.
Гарчиг нь юу буруу, хаана вэ гэдгийг хэлдэг.
Алхамууд дугаарлагдсан, яг үгчилсэн.
Хүлээсэн ба бодит хоёуланг нь хэлсэн.
Алдааны мессежүүд яг хуулагдсан, бүтэлгүйтсэн хүсэлт болон статус кодтой.
Хуудас, орчин, хэрэглэгч, төхөөрөмж, хөтөч орсон.
Хэр олон удаа гардаг, хэзээ эхэлсэн гэдгийг хэлсэн.
Дэлгэцийн зураг эсвэл бичлэг хавсарсан, хувийн мэдээллийг арилгасан.
Нэг репорт — нэг алдаа.

Mythex-ийн agent-д алдаа мэдээлэх

Mythex төсөлд репорт нь өөрөө промпт юм. Хэдэн онцлог тус болдог:

Дэлгэцийн зураг хавсаргах урьдчилан харах эсвэл алдааны дэлгэцийн — нэг мессежид 5 файл хүртэл.
/fix agent-ийг алдаа засахад төвлөрүүлдэг; Plan горим нь засварлахаасаа өмнө судлах боломжийг өгдөг.
/test нь agent-д урсгалуудыг урьдчилан харах дотор дахин гаргаж, юу харснаа тайлагнуулдаг.
Энэ цэг рүү буцах нь нөхцөлийг дордуулсан засварыг буцаадаг.

Docs-ийн промптоор дебаг хийх хуудас нь ижил хүлээсэн / бодит бүтцийг ашигладаг. Түүний эргэн засварлах, шалгах гогцоог AI-ээр бүтээсэн аппыг хэрхэн давтан сайжруулах вэ гэдгээс үзнэ үү.

Асуултууд

Баг репорт юуг агуулах ёстой вэ?

Тодорхой гарчиг, дахин үүсгэх яг алхмууд, юу хүлээснээ, юу бодитоор болсон, алдааны мессежийг үгээр нь хуулж, хаана болсон (хуудас, хөтөч, төхөөрөмж, хэрэглэгч), мөн хэрэв тусалбал дэлгэцийн зураг эсвэл бичлэг.

AI аппын бүтээгчид баг репорт хэрхэн бичих вэ?

Хөгжүүлэгчид зориулсантай ижил бүтэцтэй ашигла: алхмууд, хүлээсэн, бодит, яг алдаа. Юу өөрчлөгдөж болохгүйг нэм, мөн засвар хийгээд дараа нь засвараа шалгахыг хүс. "Энэ эвдэрсэн" гэх мэт ерөнхий промпт таамаглалд хүргэдэг.

Хэрвээ алдааг дахин үүсгэж чадахгүй бол яах вэ?

Ямар ч гэсэн репорт бич, гэхдээ тэр үед юу хийж байснаа хэл. Юу хийснээ, хэзээ болсноо, хэрэглэгчийн дансыг, харсан алдааг оруул. Хэдэн удаа гардгийг тэмдэглэ, жишээлбэл арван оролдлогын нэг удаа, учир нь тогтворгүй алдаанууд ихэвчлэн цаг хугацаа эсвэл өгөгдлийн асуудал заадаг.

Нэг репортод хэд хэдэн алдаа оруулах уу?

Үгүй. Нэг репорт — нэг алдаа, ингэснээр тус бүрийг тусад нь засаж, шалгаж, хаах боломжтой. Хэрвээ хоёр асуудал холбоотой гэж бодож байвал тус бүр дээр тэр тухай бич.