మంచి బగ్ రిపోర్ట్ ఎలా రాయాలి (AI లేదా డెవలపర్ కోసం)
మంచి బగ్ రిపోర్ట్ మీరు చూసిన అదే సమస్యను ఇతరులు — డెవలపర్ లేదా AI — మీకు ప్రశ్నలు అడగకుండానే చూడగలిగేలా చేస్తుంది. దానికి నిర్దిష్ట శీర్షిక, మళ్లీ రప్పించడానికి ఖచ్చితమైన స్టెప్లు, మీరు ఆశించినది, అసలు ఏమి జరిగింది, పదానికి పదం కాపీ చేసిన ఎర్రర్ మెసేజ్, మరియు అది ఎక్కడ జరిగింది — ఏ పేజీ, బ్రౌజర్, పరికరం మరియు వినియోగదారు — అవసరం. ఒక్క బగ్, సహాయపడితే స్క్రీన్షాట్తో.
చాలా బగ్లను అర్థం చేసుకోవడానికే పరిష్కరించడం కంటే ఎక్కువ సమయం పడుతుంది. స్పష్టమైన రిపోర్ట్ ఆ అర్థం చేసుకునే భాగాన్ని తొలగిస్తుంది. AI టూల్స్తో ఇది మరింత ముఖ్యం: "చెక్అవుట్ వింతగా ఉంది" అంటే ఏమిటో AI ఫాలో-అప్ ప్రశ్న అడగలేదు, కాబట్టి ఊహిస్తుంది — మరియు తప్పు ఊహ మరొకటి విరగ్గొట్టవచ్చు.
టెంప్లేట్
దీన్ని కాపీ చేసి నింపండి:
శీర్షిక: [ఏమి తప్పు, ఎక్కడ] — ఉదా. "బుకింగ్ ఫారమ్ రాత్రి 6 తర్వాత సమయాలను తిరస్కరిస్తుంది"
మళ్లీ రప్పించే స్టెప్లు:
1. ...
2. ...
3. ...
ఆశించినది: [ఏమి జరగాలి]
అసలు: [బదులుగా ఏమి జరిగింది]
ఎర్రర్ మెసేజ్: [ఖచ్చితమైన టెక్స్ట్, ఉంటే]
ఎక్కడ: [పేజీ/URL, బ్రౌజర్, పరికరం, ఏ వినియోగదారుగా లాగిన్ అయ్యారు]
ఎంత తరచుగా: [ప్రతిసారి / కొన్నిసార్లు / ఒకసారి]
స్క్రీన్షాట్ లేదా రికార్డింగ్: [జతచేయబడింది]
మిగతా గైడ్ ప్రతి భాగాన్ని వివరిస్తుంది.
స్టెప్ 1: ముందుగా మళ్లీ రప్పించండి
రాయడానికి ముందు, బగ్ను మళ్లీ జరిగేలా చేయడానికి ప్రయత్నించండి. ఏ స్టెప్లు ముఖ్యమైనవో, మరియు అది ప్రతిసారీ జరుగుతుందో లేదో తెలుస్తుంది.
- శుభ్రమైన స్థితితో ప్రారంభించండి: రిఫ్రెష్ చేయండి, లేదా లాగ్ అవుట్ చేసి మళ్లీ లాగిన్ అవ్వండి.
- ప్రతి క్లిక్ మరియు మీరు టైప్ చేసిన ప్రతి దాన్ని గమనించండి.
- దాన్ని ప్రేరేపించే అతి చిన్న మార్గాన్ని కనుగొనడానికి ప్రయత్నించండి.
- రెండవ బ్రౌజర్ లేదా ఖాతాను ప్రయత్నించండి. ఒక్క వినియోగదారుకే జరిగితే, అది పెద్ద సూచన.
ఇది గురించి మరింత కోసం, AI తో నిర్మించిన యాప్ను ఎలా డీబగ్ చేయాలి చూడండి.
స్టెప్ 2: నిర్దిష్ట శీర్షిక రాయండి
శీర్షిక ఏమి తప్పో మరియు ఎక్కడో చెప్పాలి, తద్వారా జాబితాను స్కాన్ చేసేవారు అది ఏ బగ్ అని తెలుసుకుంటారు.
| బలహీనం | బలమైనది |
|---|---|
| చెక్అవుట్ విరిగింది | కార్ట్లో డిస్కౌంట్ కోడ్ ఉన్నప్పుడు చెక్అవుట్ బటన్ ఏమీ చేయదు |
| మొబైల్ సమస్య | 400px కంటే తక్కువ వెడల్పు ఉన్న ఫోన్లలో ప్రైసింగ్ కార్డ్లు స్క్రీన్ దాటిపోతాయి |
| సేవ్లో ఎర్రర్ | పేరులో ఎమోజీ ఉన్న ప్రొఫైల్ను సేవ్ చేస్తే "500 Internal Server Error" చూపుతుంది |
స్టెప్ 3: ఖచ్చితమైన స్టెప్లు జాబితా చేయండి
వాటికి సంఖ్యలు ఇవ్వండి. అక్షరాలా ఉండండి: ఏ పేజీ, ఏ బటన్, మీరు ఏమి టైప్ చేశారు.
- కస్టమర్గా లాగిన్ అవ్వండి (టెస్ట్ ఖాతా: customer@example.com).
- "Starter kit" ను కార్ట్కు జోడించండి.
- డిస్కౌంట్ కోడ్
WELCOME10నమోదు చేసి Apply క్లిక్ చేయండి. - Checkout క్లిక్ చేయండి.
"కోడ్తో చెక్అవుట్ చేయడానికి ప్రయత్నించండి" అంటే తరచుగా ముఖ్యమైన వివరాలను వదిలేస్తుంది: ఏ వినియోగదారు, ఏ ఉత్పత్తి, ఏ కోడ్, అది ముందుగా అప్లై అయిందా.
స్టెప్ 4: ఆశించినది vs జరిగినది
ఇది రిపోర్ట్ యొక్క కేంద్రం. రెండూ చెప్పండి, ఎందుకంటే వ్యత్యాసమే బగ్.
- ఆశించినది: చెక్అవుట్ పేజీ తెరుచుకుంటుంది, మొత్తంలో 10% డిస్కౌంట్ చూపుతూ.
- అసలు: బటన్ ఒక క్షణం స్పిన్నర్ చూపుతుంది, తర్వాత ఏమీ జరగదు. డిస్కౌంట్ కోడ్ లేకుండా చెక్అవుట్ పని చేస్తుంది.
"ఆశించినది" లేకపోతే, ప్రవర్తన తప్పని చదివేవారికి తెలియకపోవచ్చు. "అసలు" లేకపోతే, వారు ఏమి వెతకాలో తెలియదు.
స్టెప్ 5: ఎర్రర్లను ఖచ్చితంగా కాపీ చేయండి
ఎర్రర్ మెసేజ్లు కారణానికి వేగమైన మార్గం. వాటిని పదానికి పదం టెక్స్ట్గా కాపీ చేయండి — పారాఫ్రేజ్ చేయకండి.
ఎక్కడ కనుగొనాలి:
- స్క్రీన్పై: యాప్ చూపే ఏ మెసేజ్ అయినా.
- బ్రౌజర్ కన్సోల్: డెవలపర్ టూల్స్ తెరవండి (F12, లేదా రైట్-క్లిక్ → Inspect) మరియు Console ట్యాబ్లో ఎరుపు లైన్ల కోసం చూడండి.
- Network ట్యాబ్: డెవలపర్ టూల్స్లో, విఫలమైన అభ్యర్థనను కనుగొని దాని URL మరియు స్టేటస్ కోడ్ నోట్ చేయండి (ఉదాహరణకు
POST /api/checkout → 500). - సర్వర్ లాగ్లు, మీకు యాక్సెస్ ఉంటే.
TypeError: Cannot read properties of undefined (reading 'percent') at checkout.ts:48 వంటి లైన్ తరచుగా సమస్యను నేరుగా చూపుతుంది.
స్టెప్ 6: సందర్భం జోడించండి
- ఎక్కడ: పేజీ URL, ఎన్విరాన్మెంట్ (ప్రివ్యూ, స్టేజింగ్ లేదా లైవ్).
- ఎవరు: ఏ వినియోగదారు లేదా పాత్ర — అడ్మిన్, సభ్యుడు, లాగ్ అవుట్ అయిన వ్యక్తి.
- పరికరం మరియు బ్రౌజర్: "iPhone లో Safari" vs "Windows లో Chrome" ముఖ్యం కావచ్చు.
- డేటా: రికార్డ్ గురించి ఏదైనా అసాధారణమైనది — చాలా పొడవైన టెక్స్ట్, ప్రత్యేక అక్షరాలు, పెద్ద సంఖ్యలో అంశాలు.
- ఎప్పుడు మొదలైంది: "నిన్నటి డిస్కౌంట్ కోడ్ మార్పు తర్వాత" అనేది బంగారం.
- ఎంత తరచుగా: ప్రతిసారీ, లేదా పది ప్రయత్నాల్లో ఒకసారి.
స్టెప్ 7: చూపండి
సమస్య చుట్టూ వృత్తం గీసిన స్క్రీన్షాట్, లేదా చిన్న స్క్రీన్ రికార్డింగ్ అస్పష్టతను తొలగిస్తుంది — ముఖ్యంగా లేఅవుట్ బగ్ల కోసం. మీ AI టూల్ చిత్రాలను అంగీకరిస్తే, ఒకటి జత చేయండి. కీలు మరియు ఇతరుల డేటాతో సహా ఏ ప్రైవేట్ సమాచారాన్నైనా తీసివేయండి.
AI బిల్డర్ కోసం బగ్ రిపోర్ట్లు రాయడం
అదే నిర్మాణం ప్రాంప్ట్గా కూడా పనిచేస్తుంది. రెండు జోడింపులు సహాయపడతాయి:
- ఏమి మారకూడదో చెప్పండి, తద్వారా పరిష్కారం కొత్త సమస్య తీసుకురాదు.
- పరిష్కారాన్ని ధృవీకరించమని అడగండి, కేవలం రాయమని కాదు.
కస్టమర్గా లాగిన్ అయి, కార్ట్లో "Starter kit" ఉన్నప్పుడు మరియు కోడ్
WELCOME10అప్లై అయినప్పుడు, Checkout క్లిక్ చేస్తే ఏమీ జరగదు. ఆశించినది: మొత్తంపై 10% తగ్గింపుతో చెక్అవుట్ పేజీ తెరుచుకుంటుంది. అసలు: క్షణికంగా స్పిన్నర్, తర్వాత ఏమీ లేదు. Network ట్యాబ్ చూపుతుందిPOST /api/checkout500 ఇచ్చింది. కోడ్ లేకుండా చెక్అవుట్ పని చేస్తుంది. కారణాన్ని కనుగొని, కోడ్ లేని ఆర్డర్ల కోసం ధరల లెక్కింపును మార్చకుండా పరిష్కరించండి. తర్వాత శాతం కోడ్, స్థిర మొత్తం కోడ్ మరియు కోడ్ లేకుండా చెక్అవుట్ను తనిఖీ చేయండి.
కారణం ఖచ్చితంగా తెలియకపోతే, ముందుగా నిర్ధారణ అడగండి:
ఇంకా కోడ్ మార్చవద్దు. ఈ రిపోర్ట్ ఆధారంగా, సంభావ్య కారణాలు ఏవి, మరియు ప్రతిదాన్ని ఏది నిర్ధారిస్తుంది?
సాధారణ తప్పులు
- "ఇది విరిగింది." స్టెప్లు లేవు, ఆశించిన ఫలితం లేదు, చర్య తీసుకోవడానికి ఏమీ లేదు.
- ఒకే రిపోర్ట్లో అనేక బగ్లు. కొన్ని పరిష్కరించబడతాయి, మరికొన్ని పోతాయి.
- పారాఫ్రేజ్ చేసిన ఎర్రర్లు. "ఏదో undefined" అనేది ఉపయోగకరమైన భాగాన్ని దాచేస్తుంది.
- వినియోగదారు లేదా పాత్రను విస్మరించడం. అనేక బగ్లు కేవలం అడ్మిన్లకు, లేదా కొత్త వినియోగదారులకు మాత్రమే ప్రభావం చూపుతాయి.
- మీరు కోరుకున్న పరిష్కారాన్ని మాత్రమే వివరించడం ("null తనిఖీ జోడించండి") సమస్యను కాకుండా.
- రహస్యాలను పంచుకోవడం స్క్రీన్షాట్లు లేదా అతికించిన లాగ్లలో.
చెక్లిస్ట్
- బగ్ను మళ్లీ రప్పించాను మరియు అతి చిన్న స్టెప్లను కనుగొన్నాను.
- శీర్షిక ఏమి తప్పో మరియు ఎక్కడో చెబుతుంది.
- స్టెప్లు సంఖ్యలతో మరియు అక్షరాలా ఉన్నాయి.
- ఆశించినది మరియు అసలు రెండూ చెప్పబడ్డాయి.
- ఎర్రర్ మెసేజ్లు ఖచ్చితంగా కాపీ చేయబడ్డాయి, విఫలమైన అభ్యర్థన మరియు స్టేటస్ కోడ్తో.
- పేజీ, ఎన్విరాన్మెంట్, వినియోగదారు, పరికరం మరియు బ్రౌజర్ చేర్చబడ్డాయి.
- అది ఎంత తరచుగా జరుగుతుందో మరియు ఎప్పుడు మొదలైందో చెప్పాను.
- స్క్రీన్షాట్ లేదా రికార్డింగ్ జతచేయబడింది, ప్రైవేట్ డేటా తీసివేయబడింది.
- ఒక రిపోర్ట్లో ఒక్క బగ్.
Mythex ఏజెంట్కు బగ్లను నివేదించడం
Mythex ప్రాజెక్ట్లో, రిపోర్ట్ ప్రాంప్ట్ గా ఉంటుంది. కొన్ని ఫీచర్లు సహాయపడతాయి:
- ప్రివ్యూ లేదా ఎర్రర్ స్క్రీన్ యొక్క స్క్రీన్షాట్ జత చేయండి — ఒక్కో మెసేజ్కు 5 ఫైళ్ల వరకు.
/fixబగ్ పరిష్కరించడంపై ఏజెంట్ను కేంద్రీకరిస్తుంది; Plan మోడ్ ఎడిట్ చేయడానికి ముందు అది పరిశోధించేలా చేస్తుంది./testఏజెంట్ను ప్రివ్యూలోనే ఫ్లోలను మళ్లీ రప్పించి అది చూసింది చెప్పమంటుంది.- Revert to this point పరిష్కారం పరిస్థితిని మరింత దిగజార్చితే దాన్ని వెనక్కి తీసుకుంటుంది.
డాక్స్లోని ప్రాంప్ట్లతో డీబగ్గింగ్ పేజీ అదే స్టెప్లు / ఆశించినది / అసలు నిర్మాణాన్ని ఉపయోగిస్తుంది. దాని చుట్టూ ఉన్న పరిష్కరించి తనిఖీ చేసే లూప్ కోసం, AI తో నిర్మించిన యాప్ను ఎలా ఇటరేట్ చేయాలి చూడండి.
ప్రశ్నలు
బగ్ రిపోర్ట్లో ఏమి ఉండాలి?
నిర్దిష్ట శీర్షిక, బగ్ను మళ్లీ రప్పించే ఖచ్చితమైన స్టెప్లు, మీరు ఏమి ఆశించారు, అసలు ఏమి జరిగింది, ఎర్రర్ మెసేజ్ ఉంటే పదానికి పదం, ఎక్కడ జరిగింది (పేజీ, బ్రౌజర్, పరికరం, వినియోగదారు), మరియు సహాయపడితే స్క్రీన్షాట్ లేదా రికార్డింగ్.
AI యాప్ బిల్డర్ కోసం బగ్ రిపోర్ట్ ఎలా రాయాలి?
డెవలపర్ కోసం ఉపయోగించే అదే నిర్మాణం వాడండి: స్టెప్లు, ఆశించినది, అసలు ఫలితం మరియు ఖచ్చితమైన ఎర్రర్. ఏది మారకూడదో కూడా జోడించండి, మరియు పరిష్కారాన్ని రాయడమే కాకుండా ధృవీకరించమని అడగండి. "ఇది విరిగిపోయింది" వంటి అస్పష్ట ప్రాంప్ట్లు ఊహలకు దారి తీస్తాయి.
బగ్ను మళ్లీ రప్పించలేకపోతే?
అయినా రిపోర్ట్ చేయండి, కానీ అలా చెప్పండి. మీరు ఏమి చేస్తున్నారు, అది ఎప్పుడు జరిగింది, వినియోగదారు ఖాతా, మరియు మీరు చూసిన ఏ ఎర్రర్ అయినా చేర్చండి. పది ప్రయత్నాల్లో ఒకసారి వంటివి ఎంత తరచుగా జరుగుతుందో గమనించండి, ఎందుకంటే అడపాదడపా బగ్లు తరచుగా టైమింగ్ లేదా డేటా సమస్యలను సూచిస్తాయి.
ఒకే రిపోర్ట్లో అనేక బగ్లు పెట్టవచ్చా?
లేదు. ఒక్కో రిపోర్ట్లో ఒక్క బగ్, తద్వారా ప్రతిదీ విడిగా పరిష్కరించబడి, పరీక్షించబడి, మూసివేయబడుతుంది. రెండు సమస్యలు సంబంధితమని మీరు అనుకుంటే, ప్రతి రిపోర్ట్లో ఆ విషయం చెప్పండి.