የተጠቃሚ ሰነድ-ምን መጥፎ ያደርገዋል እና እንዴት ማስተካከል እንደሚቻል

የሶፍትዌር ሰነድ የጽሁፎች ስብስብ ብቻ ነው። ግን እነሱ እንኳን ሊያሳብዱዎት ይችላሉ። በመጀመሪያ, አስፈላጊውን መመሪያ በመፈለግ ረጅም ጊዜ ያሳልፋሉ. ከዚያ ግልጽ ያልሆነውን ጽሑፍ ተረድተዋል. እንደ ተፃፈ ታደርጋለህ ፣ ግን ችግሩ አልተፈታም። ሌላ መጣጥፍ ትፈልጋለህ፣ ትደነግጣለህ...ከአንድ ሰአት በኋላ ሁሉንም ነገር ትተህ ትሄዳለህ። መጥፎ ሰነዶች የሚሠሩት በዚህ መንገድ ነው። ምን እንደዚህ ያደርገዋል እና እንዴት ማስተካከል እንደሚቻል - ከቁርጡ ስር ያንብቡ.

በድሮ ዶክመንታችን ውስጥ ብዙ ድክመቶች ነበሩ። ከላይ የተገለፀው ሁኔታ ደንበኞቻችንን እንዳይነካው አሁን ለአንድ አመት ያህል እንደገና እየሰራንበት ነው። ተመልከት፣ እንደነበረው и እንዴት ሆነ.

ችግር 1፡ ግልጽ ያልሆኑ፣ በደንብ ያልተጻፉ ጽሑፎች

ሰነዱ ለመረዳት የማይቻል ከሆነ, ነጥቡ ምንድን ነው? ግን ማንም ሰው ሆን ብሎ ለመረዳት የማይቻሉ ጽሑፎችን አይጽፍም. የሚከሰቱት ደራሲው ስለ ታዳሚው እና ስለ አላማው ሳያስብ፣ ውሃ ሲያፈስስ እና ጽሁፉን ስሕተቶች ካለበት ሳያጣራ ነው።

• ታዳሚዎቹ ፡፡. አንድ ጽሑፍ ከመጻፍዎ በፊት ስለ አንባቢው የዝግጅት ደረጃ ማሰብ አለብዎት. ለጀማሪ በቀረበ ጽሑፍ ውስጥ መሰረታዊ እርምጃዎችን መዝለል እና ቴክኒካዊ ቃላትን ያለ ማብራሪያ መተው እንደሌለበት ምክንያታዊ ነው ፣ ግን በልዩ ሁኔታ ልዩ ባለሙያተኞች በሚፈልጉት ጽሑፍ ውስጥ ፣ ፒኤችፒ የሚለውን ቃል ትርጉም ማብራራት አለብዎት ።
• ግብ. አስቀድመው ሊያስቡበት የሚገባ አንድ ተጨማሪ ነገር. ደራሲው ግልጽ የሆነ ግብ ማውጣት፣ የጽሑፉን ጠቃሚ ውጤት መወሰን እና አንባቢው ካነበበ በኋላ ምን እንደሚያደርግ መወሰን አለበት። ይህ ካልተደረገ, ለገለፃው ሲባል መግለጫ ይሰጥዎታል.
• ውሃ እና ሳንካዎች. ብዙ አላስፈላጊ መረጃዎች እና ቢሮክራሲዎች አሉ, ስህተቶች እና የአጻጻፍ ስልቶች በአመለካከት ውስጥ ጣልቃ ይገባሉ. አንባቢው ሰዋሰው ናዚ ባይሆንም በጽሑፉ ውስጥ ግድየለሽነት እሱን ሊያጠፋው ይችላል።

ከላይ ያሉትን ምክሮች ግምት ውስጥ ያስገቡ, እና ጽሑፎቹ ይበልጥ ግልጽ ይሆናሉ - ዋስትና ያለው. የበለጠ የተሻለ ለማድረግ የእኛን ይጠቀሙ በቴክኒካዊ ሰነዶች ላይ ሲሰሩ 50 ጥያቄዎች.

ችግር 2. መጣጥፎች ሁሉንም ጥያቄዎች አይመልሱም

ሰነዱ ከዕድገቱ ጋር የማይጣጣም, ለትክክለኛ ጥያቄዎች መልስ የማይሰጥ ከሆነ እና በእሱ ውስጥ ያሉ ስህተቶች ለዓመታት ሳይስተካከሉ ሲቀሩ መጥፎ ነው. እነዚህ ችግሮች የጸሐፊው ብዙ አይደሉም, ነገር ግን በኩባንያው ውስጥ የሂደቶች አደረጃጀት.

ሰነዶች ከዕድገት ጋር አይሄዱም።

ባህሪው አስቀድሞ በመልቀቅ ላይ ነው፣ የግብይት እቅድ ለመሸፈን አቅዷል፣ እና አዲሱ መጣጥፍ ወይም ትርጉም አሁንም በሰነዱ ውስጥ እንደሌለ ታወቀ። በዚህ ምክንያት መልቀቂያውን ለሌላ ጊዜ ማስተላለፍ ነበረብን። ሁሉም ሰው የፈለጉትን ያህል ስራዎችን ለቴክኒካል ፀሃፊዎች እንዲያስረክቡ መጠየቅ ይችላሉ ነገር ግን አይሰራም። ሂደቱ በራስ-ሰር ካልሆነ, ሁኔታው ​​​​እንደገና ይደገማል.

በYouTrack ላይ ለውጦችን አድርገናል። ስለ አዲስ ባህሪ ጽሑፍ የመጻፍ ተግባር ባህሪው መሞከር በሚጀምርበት በተመሳሳይ ጊዜ ለቴክኒካል ጸሐፊው ይወርዳል። ከዚያ ለማስታወቂያ ለመዘጋጀት ማርኬቲንግ ስለ እሱ ይማራል። ማሳወቂያዎች ወደ Mattermost ኮርፖሬት መልእክተኛም ይመጣሉ፣ ስለዚህ ከገንቢዎች የሚመጡ ዜናዎችን ማጣት በቀላሉ የማይቻል ነው።

ሰነድ የተጠቃሚ ጥያቄዎችን አያንጸባርቅም።

እኛ እንደዚህ ለመስራት እንለማመዳለን-ባህሪ ወጣ ፣ ስለ እሱ ተነጋገርን። እንዴት ማብራት፣ ማጥፋት እና ጥሩ ማስተካከያ ማድረግ እንዳለብን ገለጽን። ነገር ግን አንድ ደንበኛ የእኛን ሶፍትዌር እኛ ባልጠበቅነው መንገድ ቢጠቀምስ? ወይስ እኛ ያላሰብናቸው ስህተቶች አሉት?

ሰነዱ በተቻለ መጠን የተሟላ መሆኑን ለማረጋገጥ የድጋፍ ጥያቄዎችን ፣ በርዕስ መድረኮች ላይ ያሉ ጥያቄዎችን እና በፍለጋ ሞተሮች ውስጥ ያሉ ጥያቄዎችን ለመተንተን እንመክራለን። በጣም ተወዳጅ ርዕሶች ነባር ጽሑፎችን እንዲያሟሉ ወይም አዲስ እንዲጽፉ ወደ ቴክኒካል ጸሐፊዎች ይዛወራሉ.

ሰነዶች እየተሻሻሉ አይደሉም

ወዲያውኑ በትክክል ማድረግ ከባድ ነው, አሁንም ስህተቶች ይኖራሉ. የደንበኞችን አስተያየት ተስፋ ማድረግ ትችላለህ፣ ነገር ግን እያንዳንዱን የትየባ፣ የተሳሳቱ፣ ለመረዳት የማይቻል ወይም መሠረተ ቢስ መጣጥፍ ሪፖርት ያደርጋሉ ብሎ ማሰብ ዘበት ነው። ከደንበኞች በተጨማሪ ሰራተኞች ሰነዶቹን ያነባሉ, ይህም ማለት ተመሳሳይ ስህተቶችን ያያሉ. ይህ ጥቅም ላይ ሊውል ይችላል! ችግርን ሪፖርት ለማድረግ ቀላል የሚሆኑበትን ሁኔታዎች መፍጠር ብቻ ያስፈልግዎታል።

ሰራተኞች በሰነድ ላይ አስተያየቶችን ፣ አስተያየቶችን እና ሀሳቦችን የሚተዉበት የውስጥ ፖርታል ላይ ቡድን አለን። ድጋፍ ጽሑፍ ያስፈልገዋል፣ ግን የለም? ሞካሪው ስሕተቱን አስተውሏል? ባልደረባው ስለ ስህተቶች ለልማት አስተዳዳሪዎች ቅሬታ አቅርቧል? ሁሉም በዚህ ቡድን ውስጥ! ቴክኒካል ጸሃፊዎች አንዳንድ ነገሮችን ወዲያውኑ ያስተካክላሉ፣ አንዳንድ ነገሮችን ወደ YouTrack ያስተላልፋሉ እና ሌሎች እንዲያስቡበት የተወሰነ ጊዜ ይሰጣሉ። ርዕሱ እንዳይሞት ለመከላከል, ከጊዜ ወደ ጊዜ የቡድኑን መኖር እና የአስተያየት አስፈላጊነትን እናስታውስዎታለን.

ችግር 3. ትክክለኛውን ጽሑፍ ለማግኘት ረጅም ጊዜ ይወስዳል.

የማይገኝ ጽሁፍ ከማይገኝ ጽሁፍ አይሻልም። የጥሩ ሰነድ መሪ ቃል “ለመፈለግ ቀላል፣ ለማግኘት ቀላል” መሆን አለበት። ይህንን እንዴት ማግኘት ይቻላል?

አወቃቀሩን ያደራጁ እና ርዕሶችን ለመምረጥ መርሆውን ይወስኑ. አንባቢው “ይህን ጽሑፍ ከየት ማግኘት እችላለሁ?” ብሎ እንዳያስብ አወቃቀሩ በተቻለ መጠን ግልጽ መሆን አለበት። ለማጠቃለል, ሁለት አቀራረቦች አሉ-ከመገናኛ እና ከተግባሮች.

1. ከመገናኛው. ይዘቱ የፓነል ክፍሎችን ያባዛል. ይህ በአሮጌው የአይኤስፒ ሲስተም ሰነድ ውስጥ ነበር።
2. ከተግባራት። የጽሁፎች እና ክፍሎች ርዕሶች የተጠቃሚዎችን ተግባራት ያንፀባርቃሉ; ርዕሶች ሁልጊዜ ማለት ይቻላል ለ"እንዴት" ለሚለው ጥያቄ ግሦች እና መልሶች ይይዛሉ። አሁን ወደዚህ ቅርጸት እንሸጋገራለን.

የመረጡት አካሄድ ምንም ይሁን ምን ርእሱ ተጠቃሚዎች ከሚፈልጉት ጋር የሚዛመድ መሆኑን እና የተጠቃሚውን ጥያቄ በተለየ መንገድ መያዙን ያረጋግጡ።

የተማከለ ፍለጋን ያዋቅሩ. ተስማሚ በሆነ ዓለም ውስጥ፣ በቋንቋው ፊደል ሲሳሳቱ ወይም ሲሳሳቱም ፍለጋ መሥራት አለበት። በኮንፍሉንስ ውስጥ ያደረግነው ፍለጋ በዚህ ሊያስደስተን አይችልም። ብዙ ምርቶች ካሉዎት እና ሰነዱ አጠቃላይ ከሆነ፣ ፍለጋውን ተጠቃሚው ባለበት ገጽ ያስተካክሉት። በእኛ ሁኔታ, በዋናው ገጽ ላይ ያለው ፍለጋ ለሁሉም ምርቶች ይሰራል, እና አስቀድመው በአንድ የተወሰነ ክፍል ውስጥ ከሆኑ, በእሱ ውስጥ ላሉት ጽሑፎች ብቻ ነው.

ይዘት እና የዳቦ ፍርፋሪ ይጨምሩ. እያንዳንዱ ገጽ ምናሌ እና የዳቦ ፍርፋሪ ሲኖረው ጥሩ ነው - ወደ ማንኛውም ደረጃ የመመለስ ችሎታ ያለው የተጠቃሚው መንገድ ወደ የአሁኑ ገጽ። በአሮጌው የአይኤስፒ ሲስተም ሰነድ ውስጥ ወደ ይዘቱ ለመድረስ ከጽሑፉ መውጣት ነበረብህ። የማይመች ነበር, ስለዚህ በአዲሱ ውስጥ አስተካክለነዋል.

በምርቱ ውስጥ አገናኞችን ያስቀምጡ. ሰዎች በተመሳሳዩ ጥያቄ ደግመው ደጋግመው ከመጡ፣ በመፍትሔው ላይ ፍንጭ ማከል ተገቢ ነው። አንድ ተጠቃሚ ችግር ሲያጋጥመው መረጃ ወይም ግንዛቤ ካሎት በደብዳቤ ዝርዝር ማሳወቅ ይችላሉ። አሳቢነታቸውን አሳያቸው እና ሸክሙን ከድጋፍ ውሰዱ።

በብቅ ባዩ መስኮቱ በቀኝ በኩል በ ISPmanager የጎራ አስተዳደር ክፍል ውስጥ DNSSEC ን ስለማዋቀር ወደ አንድ መጣጥፍ አገናኝ አለ።

በሰነዶች ውስጥ ተሻጋሪ ማጣቀሻዎችን ያዘጋጁ. አንዳቸው ከሌላው ጋር የተያያዙ ጽሑፎች "መያያዝ" አለባቸው. ጽሑፎቹ በቅደም ተከተል ከሆኑ በእያንዳንዱ ጽሑፍ መጨረሻ ላይ ወደ ፊት እና ወደ ኋላ ቀስቶችን ማከልዎን ያረጋግጡ።

ምናልባትም አንድ ሰው በመጀመሪያ ለጥያቄው መልስ ለማግኘት ወደ እርስዎ ሳይሆን ወደ የፍለጋ ሞተር ይሄዳል። በቴክኒካል ምክንያቶች ወደ ሰነዱ ምንም አገናኞች ከሌሉ አሳፋሪ ነው። ስለዚህ የፍለጋ ሞተር ማመቻቸትን ይንከባከቡ.

ችግር 4. ጊዜ ያለፈበት አቀማመጥ በማስተዋል ውስጥ ጣልቃ ይገባል

ከመጥፎ ጽሑፎች በተጨማሪ ሰነዶች በንድፍ ሊበላሹ ይችላሉ. ሰዎች በደንብ የተጻፉ ቁሳቁሶችን ማንበብ ለምደዋል። ብሎጎች, ማህበራዊ አውታረ መረቦች, ሚዲያ - ሁሉም ይዘቶች ውብ ብቻ ሳይሆን ለማንበብ ቀላል እና ለዓይን ደስ የሚያሰኙ ናቸው. ስለዚህ ከዚህ በታች ባለው ስክሪፕት ላይ እንደ ጽሁፍ የሚያይ ሰው ህመም በቀላሉ ሊረዱት ይችላሉ።

በዚህ ጽሑፍ ውስጥ በጣም ብዙ ቅጽበታዊ ገጽ እይታዎች እና ድምቀቶች አሉ እነሱ አይረዱም ፣ ግን በአመለካከት ውስጥ ጣልቃ መግባት ብቻ (ምስሉ ጠቅ ሊደረግ ይችላል)

ከሰነዶቹ ብዙ ውጤቶች ጋር ረጅም ንባብ ማድረግ የለብዎትም ፣ ግን መሰረታዊ ህጎችን ግምት ውስጥ ማስገባት አለብዎት።

አቀማመጥ. የሰውነት ጽሑፍ ስፋት፣ ቅርጸ-ቁምፊ፣ መጠን፣ አርእስት እና ንጣፍ ይወስኑ። ዲዛይነር መቅጠር እና ስራውን ለመቀበል ወይም እራስዎ ለመስራት የአርቲም ጎርቡኖቭን "የታይፕግራፊ እና አቀማመጥ" መጽሐፍ ያንብቡ. የአቀማመጡን አንድ እይታ ብቻ ያቀርባል, ግን በጣም በቂ ነው.

ምደባዎች. በጽሑፉ ላይ አጽንዖት የሚያስፈልገው ምን እንደሆነ ይወስኑ. በተለምዶ ይህ በበይነገጽ ፣ አዝራሮች ፣ የኮድ ማስገቢያዎች ፣ የውቅረት ፋይሎች ፣ “እባክዎ ያስተውሉ” ብሎኮች ውስጥ ያለ መንገድ ነው። የእነዚህ ንጥረ ነገሮች ምደባ ምን እንደሚሆን ይወስኑ እና በደንቦቹ ውስጥ ይመዝግቡ። አነስተኛ ፈሳሽ, የተሻለ እንደሚሆን ያስታውሱ. ብዙ ሲሆኑ ጽሑፉ ጫጫታ ነው። የጥቅስ ምልክቶች እንኳን ብዙ ጊዜ ጥቅም ላይ ከዋሉ ጫጫታ ይፈጥራሉ።

ቅጽበታዊ ገጽ እይታዎች. ቅጽበታዊ ገጽ እይታዎች በሚያስፈልጉበት ጊዜ ከቡድኑ ጋር ይስማሙ። በእርግጠኝነት እያንዳንዱን እርምጃ መግለጽ አያስፈልግም. ብዛት ያላቸው ቅጽበታዊ ገጽ እይታዎች፣ ጨምሮ። አዝራሮችን ይለያዩ ፣ በአመለካከት ውስጥ ጣልቃ ይግቡ ፣ አቀማመጡን ያበላሹ። መጠኑን ይወስኑ, እንዲሁም የድምቀቶች እና የፊርማዎች ቅርጸት በቅጽበታዊ ገጽ እይታዎች ላይ እና በመተዳደሪያ ደንቦቹ ውስጥ ይመዝግቡ. ምሳሌዎች ሁልጊዜ ከተጻፈው ጋር መዛመድ እና ተዛማጅ መሆን እንዳለባቸው ያስታውሱ። በድጋሚ, ምርቱ በመደበኛነት ከተዘመነ, ሁሉንም ሰው መከታተል አስቸጋሪ ይሆናል.

የጽሑፍ ርዝመት. ከመጠን በላይ ረጅም መጣጥፎችን ያስወግዱ። እነሱን ወደ ክፍሎች ይከፋፍሏቸው እና ይህ የማይቻል ከሆነ ወደ መጣጥፉ መጀመሪያ ላይ ይዘትን ከመልህቅ አገናኞች ጋር ይጨምሩ። ጽሑፉን በእይታ አጭር ለማድረግ ቀላሉ መንገድ ጠባብ የአንባቢዎች ክበብ የሚያስፈልጉትን ቴክኒካዊ ዝርዝሮች በብልሽት ስር መደበቅ ነው።

ፎርማቶች. በጽሁፎችዎ ውስጥ ብዙ ቅርጸቶችን ያዋህዱ፡ ጽሑፍ፣ ቪዲዮ እና ምስሎች። ይህ ግንዛቤን ያሻሽላል።

በሚያምር አቀማመጥ ችግሮችን ለመሸፈን አይሞክሩ. እንደ እውነቱ ከሆነ እኛ እራሳችን “መጠቅለያው” ጊዜው ያለፈበትን ሰነድ ያድናል ብለን ተስፋ አድርገን ነበር - አልሰራም። ጽሑፎቹ በጣም ብዙ የእይታ ጫጫታ እና አላስፈላጊ ዝርዝሮችን ስለያዙ ደንቦቹ እና አዲስ ዲዛይን አቅመ-ቢስ ነበሩ።

ከላይ ያሉት አብዛኛዎቹ የሚወሰኑት ለሰነዶች በሚጠቀሙበት መድረክ ነው። ለምሳሌ, Confluence አለን. እኔም ከእሱ ጋር መማከር ነበረብኝ። ፍላጎት ካለህ የድረ-ገጽ ገንቢያችንን ታሪክ አንብብ፡- ለሕዝብ ዕውቀት መሠረት ማግባባት፡ ንድፉን መለወጥ እና በቋንቋዎች መለያየትን ማዘጋጀት.

የት መሻሻል መጀመር እና እንዴት መኖር እንደሚቻል

ሰነድህ እንደ አይኤስፒ ሲስተም ሰፊ ከሆነ እና የት መጀመር እንዳለብህ ካላወቅህ በትልቁ ችግሮች ጀምር። ደንበኞች ሰነዱን አይረዱም - ጽሑፎቹን ያሻሽሉ, ደንቦችን ያዘጋጁ, ጸሐፊዎችን ያሠለጥኑ. ሰነዶች ጊዜው ያለፈበት ነው - የውስጥ ሂደቶችን ይንከባከቡ. ስለ በጣም ታዋቂ ምርቶች በጣም ታዋቂ ከሆኑ ጽሑፎች ይጀምሩ: ድጋፍ ይጠይቁ, በፍለጋ ሞተሮች ውስጥ የጣቢያ ትንታኔዎችን እና ጥያቄዎችን ይመልከቱ.

ወዲያውኑ እንበል - ቀላል አይሆንም. እና በፍጥነት ለመስራትም የማይቻል ነው. ገና ካልጀመርክ እና ትክክለኛውን ነገር ካላደረግክ በስተቀር። አንድ በእርግጠኝነት የምናውቀው ነገር በጊዜ ሂደት የተሻለ እንደሚሆን ነው. ግን ሂደቱ መቼም አያልቅም :-).

ምንጭ: hab.com