paint-brush
ጥሩ የሳንካ ሪፖርቶችን እንዴት መፃፍ እንደሚቻል፡ ምክሮች@iamhouser
አዲስ ታሪክ

ጥሩ የሳንካ ሪፖርቶችን እንዴት መፃፍ እንደሚቻል፡ ምክሮች

Evgeny Domnin6m2024/10/14
Read on Terminal Reader

በጣም ረጅም፤ ማንበብ

TL;DR: ግልጽ እና ዝርዝር የሳንካ ሪፖርቶችን መፃፍ ጊዜን ይቆጥባል እና ለገንቢዎች እና ሞካሪዎች ብስጭት ይቀንሳል። ጥሩ የሳንካ ሪፖርት ገላጭ ርዕስ፣ የተወሰኑ የአካባቢ ዝርዝሮችን፣ ግልጽ የሆኑ የመራቢያ እርምጃዎችን ከተገቢው የሙከራ ውሂብ እና የሚጠበቁ/ትክክለኛ ውጤቶችን ማካተት አለበት። ቅጽበታዊ ገጽ እይታዎች፣ የስህተት ምዝግብ ማስታወሻዎች እና የኮንሶል ውጤቶች ግልጽነት ወሳኝ ናቸው። ተገቢ መረጃ ያላቸው የተዋቀሩ ሪፖርቶች ወደኋላ እና ወደኋላ ይቀንሳሉ፣የዕድገቱን ሂደት ያመቻቹ እና ፈጣን መፍትሄዎችን ያስገኛሉ። እነዚህን ልምምዶች ማመጣጠን የቡድን ግንኙነትን እና የፕሮጀክት ግስጋሴን ያሻሽላል።
featured image - ጥሩ የሳንካ ሪፖርቶችን እንዴት መፃፍ እንደሚቻል፡ ምክሮች
Evgeny Domnin HackerNoon profile picture
0-item

አንተ ገንቢ እንደሆንክ አድርገህ አስብ፣ እና ሞካሪ በድጋሜ ወቅት የተገኘ ሳንካ ያመጣልሃል። ይህን ስህተት ማስተካከል ትፈልጋለህ፣ ስለዚህ ትኬት እንዲፈጠር ትጠይቃለህ። የምርት አስተዳዳሪው ምንም አይነት ጥያቄ እንዳይኖረው እንዴት እንደሚያነሱት፣ የመሳብ ጥያቄዎችን ከእሱ ጋር እንደሚያገናኙት እና ግምቶችን እንደሚያክሉ አስቀድመው እያሰቡ ነው።


የተወሰነ ጊዜ አለፈ፣ እና አዲስ ቲኬት ታየ፣ ግን ውስጥ፣ ሁለት መስመሮች እና ቅጽበታዊ ገጽ እይታ ብቻ አሉ። በቁጭት ፣ ይህንን መረጃ ተጠቅመህ ስህተቱን እንደገና ለማባዛት ትሞክራለህ ፣ ግን ምንም ስህተት የለም። ብዙ ጊዜ ሞክረዋል፣ ነገር ግን በመጨረሻ፣ ለሙከራው ስህተት እንደገና ሊባዛ እንደማይችል ይጽፋሉ፣ እና አዲስ የማብራሪያ ዙር ይጀምራል።


በአዳዲስ ስራዎች ላይ ለመስራት፣ ሌሎች ስህተቶችን ለማስተካከል፣ ወይም አኒም ኮዱን ሲያስተካክል ለመመልከት ሊያገለግል የሚችል ጊዜ እያጠፉ ነው።


ስሜ Evgeny Domnin ነው; እኔ QA ነኝ፣ እና ጥሩ የሳንካ ሪፖርት በሚያደርገው ነገር ላይ ያለኝን እይታ ለማካፈል እሞክራለሁ። ለረጅሙ መግቢያ ይቅርታ - እንጀምር።

ርዕስ

በቲኬቱ ርዕስ ውስጥ ሶስት ጥያቄዎችን ለመመለስ ይሞክሩ።

  1. የት ነው የሚከሰተው?
  2. ምን ይሆናል?
  3. በምን ሁኔታዎች?


ልምድ ያለው ገንቢ ጉዳዩን ለመረዳት ርዕሱን ማየት ብቻ ያስፈልገዋል። ለምሳሌ፡-


የመግቢያ ገጽ፡- የተሳሳተ የይለፍ ቃል በሚያስገቡበት ጊዜ መስኩ አይደምቅም።

አካባቢ

ብዙ ጊዜ ሞካሪዎች ችግሩ በየትኛው አካባቢ እንደተከሰተ በቲኬቱ ላይ መግለጽ ሲረሱ አይቻለሁ። ይህ በተለይ ከUI ጋር በተያያዙ ቲኬቶች ውስጥ የድረ-ገፁ አድራሻ ወይም የአውታረ መረብ ጥያቄ በማይታይበት ጊዜ ጠቃሚ ነው። ይህንን ሁልጊዜ ይግለጹ። በቲኬቱ ውስጥ የተለየ መስክ ካለ, በጣም ጥሩ, እዚያ ያስቀምጡት. ካልሆነ በመራቢያ ደረጃዎች ውስጥ ይጥቀሱት ለምሳሌ፡-


በአስተዳዳሪ መለያ ወደ ማዘጋጃ አካባቢ ይግቡ።


ስለ እርምጃዎች ስንናገር…

የመራቢያ ደረጃዎች

በጣም አስፈላጊ ከሆኑት ክፍሎች አንዱ የሳንካ ማባዛት መመሪያ ነው. ለማተኮር ሁለት ክፍሎችን እገልጻለሁ፡ የእርምጃዎች ቅርጸት (ምስላዊ) እና ይዘቱ (ውስጥ ያለው ውሂብ)።

የእይታ ክፍል

መዋቅርን መጠበቅ

የሳንካ ሪፖርቶች የተለያዩ ልዩነቶች አሉ፣ ግን በጥንታዊ ደረጃ፣ የሚከተሉትን ክፍሎች መያዝ አለባቸው።

  1. እርምጃዎች
  2. የሚጠበቀው ውጤት
  3. ትክክለኛ ውጤት


ይህንን መዋቅር ይጠቀሙ, እና ሁልጊዜ በእሱ ላይ ይጣበቃሉ. ጉዳዩን በሚገልጹበት ጊዜ ተመሳሳይነት ሃሳቦቻችሁን ለማደራጀት ከሚረዱት ጉዳዮች አንዱ ይህ ነው።


ቁጥር ያለው ዝርዝር ተጠቀም

ቁጥር ያለው ዝርዝር በመጠቀም ደረጃዎቹን ይከፋፍሉ. አንዳንድ ጊዜ ሞካሪዎች ዝርዝር መግለጫዎችን ይጽፋሉ, ነገር ግን እንደ ቀጣይ የጽሑፍ እገዳ. ይህን አታድርግ። ደረጃዎቹ ከተለያዩ ለማንበብ ለሁሉም ሰው በጣም ቀላል ይሆናል.


በተቻለ መጠን ያለ ሰዋሰዋዊ ስህተቶች ይጻፉ።


አሁን፣ ወደ እነዚህ እርምጃዎች ይዘት እንሂድ።

በመግለጫዎች ውስጥ የጋራ ስሜት

ስህተትን እንደገና ለማራባት ወሳኝ ካልሆነ እያንዳንዱን እርምጃ ወደ ተለየ ደረጃ መከፋፈል አያስፈልገዎትም - ይህ ለማንበብ እና በተግባር ለመጠቀም ከባድ ነው። ብዙ ድርጊቶችን በአንድ እርምጃ ለማካተት አትፍሩ። ምን ለማለት ፈልጌ ነው?


መጥፎ :

  1. ወደ test.com/login ይሂዱ

  2. የመግቢያ መስኩ ላይ ጠቅ ያድርጉ

  3. መግቢያውን ያስገቡ

  4. በይለፍ ቃል መስኩ ላይ ጠቅ ያድርጉ

  5. የይለፍ ቃሉን ያስገቡ


ጥሩ

  1. ወደ test.com/login ይሂዱ እና በማንኛውም መለያ ይግቡ


ደረጃውን የጠበቀ ፍሰት በሚከተልበት ጊዜ ገንቢው በተፈጥሮ በሚያደርጋቸው ነገሮች ደረጃዎቹን አንከፋፈልም። ስጀምር እያንዳንዱ እርምጃ የራሱ እርምጃ ያስፈልገዋል ብዬ አስብ ነበር ነገር ግን አስፈላጊ አይደለም.


አሻሚነትን ያስወግዱ

በእያንዳንዱ ደረጃ ላይ ለመፈተሽ ሁልጊዜ እርምጃዎችን በልዩ ጥያቄ ያካትቱ እና ለመጫን የተወሰነውን ቁልፍ ይፃፉ (በተለይ ተመሳሳይ ስም ያላቸው አዝራሮች ካሉ)።


የሙከራ ውሂብን ያካትቱ

ስህተቱ ከመለያዎ ጋር የሚዛመድ ከሆነ የመግቢያ ውሂብ ያቅርቡ እና ስህተቱን እንደገና ለማባዛት የሚያግዙ የሙከራ ክፍያዎችን ለማካተት አያመንቱ።


እርምጃዎችዎን እንደገና ይገምግሙ

አንዳንድ ጊዜ፣ ስህተቱን ካጋጠመዎት በኋላ ወዲያውኑ ደረጃዎቹን ይጽፋሉ፣ ነገር ግን ለሙሉ መረዳት አንድ እርምጃ አምልጦት ሊሆን ይችላል ወይም ስህተቱ በኋላ እንደገና ሊባዛ አይችልም። በዚህ ጊዜ፣ ይበልጥ ትክክለኛ የሆኑ እርምጃዎችን ማግኘት ሊያስፈልግ ይችላል።

የሚጠበቀው ውጤት

የተለየ ክፍል የሚጠበቀው ውጤት ነው, እሱም ደረጃዎችን በሚከተሉበት ጊዜ የሚጠበቀውን ውጤት እንገልፃለን (በማይገርም ሁኔታ). ይህ ክፍል መኖር አለበት ከሚለው ውጪ ብዙ ልዩ ምክሮች እዚህ የሉም - ገንቢው ተግባራዊነቱ ወደ ምን ባህሪ መምራት እንዳለበት መረዳት አለበት። እንደ “ሁሉም ነገር በጥሩ ሁኔታ መሥራት አለበት” ያሉ ሐረጎች አይቆርጡም - ልዩ ባህሪን ይፃፉ።

ትክክለኛ ውጤት

እዚህ, ደረጃዎቹን ስንከተል በትክክል የተከሰተውን እንጽፋለን. ልዩነት እዚህም አስፈላጊ ነው። “ሁሉም ነገር ተበላሽቷል” ብለህ ብቻ አትፃፍ (ምንም እንኳን ያ ሳይሆን አይቀርም)። ሁሉም ነገር እንደተበላሸ የሚያሳዩትን አመልካቾች ይግለጹ. ለምሳሌ፡-


GET /accounts ጥያቄ ላይ 500 ስህተት ተመልሷል ፣ እና ዩአይዩ ታግዷል። ተጠቃሚው ከገጹ መውጣት ወይም አባሎችን ጠቅ ማድረግ አይችልም።


ገጹን ማደስ ጥያቄውን እንደገና ያስነሳል እና ወደ ተመሳሳይ ስህተት ይመራል.


በሌላ አነጋገር ትክክለኛውን ውጤት እና የተጠቃሚውን ፍሰት እንዴት እንደሚጎዳ ይግለጹ።

ተጨማሪ ፋይሎች

ይህ ሊጠቀስ የሚገባው የተለየ ክፍል ነው። ስህተቱን የሚገልጽ ተጨማሪ መረጃ የሚያያይዙበት ነው። የመራቢያ ደረጃዎችን የማንበብ አድናቂዎች ያልሆኑ አንዳንድ ገንቢዎችን አውቃለሁ እና በቀጥታ ወደ ትክክለኛው ውጤት እና ወደሚያብራሩ ተጨማሪ ቁሳቁሶች ይሂዱ።

የስህተት ቅጽበታዊ ገጽ እይታዎች

መቶ ጊዜ ከመስማት አንድ ጊዜ ማየት ይሻላል። ይህ ምን እየተከሰተ እንዳለ እና የት እንደሆነ በእይታ ለማሳየት ጥሩ መንገድ ነው። ሁልጊዜ ቅጽበታዊ ገጽ እይታን ለማያያዝ ይሞክሩ።

ጥያቄ

ስህተቱ የተከሰተበት ጥያቄ ካለ ሁል ጊዜ በቲኬቱ ውስጥ መካተት አለበት። ነገር ግን፣ ጥያቄዎች ብዙ የተለያዩ መለኪያዎችን ይይዛሉ። የሚከተሉትን ማካተት አስፈላጊ እንደሆነ አጉላለሁ፡-

  • የስህተት ዩአርኤል - ጥያቄው ራሱ፣ ሙከራው በሚካሄድበት አሳሽ ውስጥ ካለው የአውታረ መረብ ክፍል ማግኘት ይችላሉ።


  • ዘዴ - GETPOSTTRACEOPTION ፣ ወዘተ ብዙ ዘዴዎች አሉ ፣ ልክ ተመሳሳይ ዩአርኤል ያላቸው ግን የተለያዩ ዘዴዎች ያሉ ጥያቄዎች አሉ። በቲኬቱ ውስጥ መግለጽዎን አይርሱ.


  • የስህተት ኮድ - ሌላ አስፈላጊ ነጥብ. ምናልባት ላይረሱት ይችላሉ፣ ነገር ግን ከአገልጋዩ የተመለሰውን ኮድ ማስታወስዎን አይርሱ።


  • ክፍያ - ይህ ለአገልጋዩ በጥያቄያችን ውስጥ የላክነው ውሂብ ነው። ይህ በእያንዳንዱ ጥያቄ ላይ የለም (ለምሳሌ፣ HEAD ወይም GET የለዎትም)፣ ግን የስህተቱ መንስኤ ሊሆን ይችላል።


  • ምላሽ - የአገልጋዩ ምላሽ. አንዳንድ ጊዜ ሙሉ ስህተቱን ይይዛል፣ የት እንደተከሰተ እንኳን ያሳያል፣ሌላ ጊዜ ደግሞ ለዚያ አይነት ስህተት በጀርባው ላይ የተቀመጠው ነባሪ ቦታ ያዥ ነው። ይህንን ማካተትዎን ያረጋግጡ - ገንቢውን ብዙ ጊዜ ይቆጥባል።

የኮንሶል ምዝግብ ማስታወሻዎች

አንዳንድ ጊዜ, ስህተቶች በኮንሶል ውስጥ ይገኛሉ, እና እነዚህ ወደ ቲኬቱ ሊጨመሩ ይችላሉ. ምናልባት ይህን ቀድመህ እየሠራህ ሊሆን ይችላል፣ ነገር ግን አንድ ትልቅ የጽሑፍ ብሎክ ሁልጊዜ እንደ .log ፋይል ሊቀመጥ እና በቲኬቱ ላይ እንደሚጨመር አስተውያለሁ። ይህ ሁለቱንም የምዝግብ ማስታወሻዎች እና የቲኬቱን ተነባቢነት ያሻሽላል።

ይህ ሁሉ ደህና እና ጥሩ ነው ፣ ግን ...


ይህ ሁሉ ደህና እና ጥሩ ነው፣ ነገር ግን ሁሉም ነገር እንደዚህ የሚያምር ለማድረግ ጊዜ ከየት እናገኛለን? የጊዜ ገደብ እየቀረበ ነው፣ ስራ አስኪያጁ እየተናደደ ነው፣ ፕሮዳክሽኑ ውስጥ እገዳ አለ፣ እና ሁሉንም ነገር እንድጽፍ እየተጠየቅኩ ነው? ለገንቢው በቀጥታ መልእክት እልካለሁ፣ እና ያ ነው።


ይህ ሊነሳ የሚችል ምክንያታዊ ክርክር ነው. ለሙከራ በቂ ጊዜ የተመደበለት፣ ሁሉም ነገር በሂደት የሚሄድበት፣ እና የተሟላ እና ከፍተኛ ጥራት ያለው ሰነድ ስለሚቀመጥበት ስለ ፍጹም ሞካሪው አለም ምንም አይነት ቅዠት አላደርግም። ተረድቻለሁ-ብዙውን ጊዜ፣ ጊዜው መሰባበር፣ ማቃጠል... ደህና፣ አይኖች፣ እና ሁሉንም ነገር በጊዜው ለማከናወን የሚደረግ ሩጫ ነው።


ትንንሽ ስህተቶች ወደ መከመር ይቀናቸዋል፣ በዐውደ-ጽሑፍ መቀያየር ምክንያት ብዙ ጊዜ ይወስዳሉ እና ወደ ደካማ አሠራሮች ያመራል። ማሻሻያዎችን ቀስ በቀስ መተግበር ከጀመርን እና እንዴት እንደሚሰሩ መከታተል ከጀመርን የበለጠ የተረጋጋ፣ ደረጃውን የጠበቀ እና ለሁሉም ተሳታፊዎች ሊተነበይ የሚችል ሂደት መፍጠር እንችላለን።


የፕሮጀክት አስተዳዳሪው ሁሉንም ሰው ለዝማኔዎች መሳብ ሳያስፈልገው በምርቱ ላይ ምን እየተፈጠረ እንዳለ ይገነዘባል፣ ገንቢው የመራቢያ ሁኔታዎች ላይ ማብራሪያ እንዲሰጥ ሞካሪውን መጠየቅ አይኖርበትም እና ከሙከራ አያርቃቸውም እና ባለድርሻ አካላት በተራው፣ ስለ ምርቱ እድገት ግልጽ የሆነ እይታ ይኑርዎት.


ይህ መጣጥፍ ይበልጥ ያነጣጠረው በፈተና ውስጥ መንገዳቸውን ለጀመሩ ወይም ለጀመሩ ጀማሪዎች ነው። ትናንሽ እርምጃዎች ወደ ትልቅ ውጤቶች እንደሚመሩ አምናለሁ, እና በዚህ ጽሑፍ ውስጥ ያሉት ምክሮች ከፍተኛ ጥራት ያላቸውን የሳንካ ሪፖርቶችን ይመራሉ.


ማንኛቸውም ጥያቄዎች፣ ጥቆማዎች፣ አለመግባባቶች ወይም ቅሬታዎች ካሉዎት በአስተያየቶቹ ውስጥ ለመተው ነፃነት ይሰማዎ - አስተያየትዎን ለመስማት ፍላጎት አለኝ!