ഡോക്യുമെന്റേഷന്റെ ഗുണനിലവാരം ഞങ്ങൾ എങ്ങനെ വിലയിരുത്തി

ഹലോ, ഹബ്ർ! എൻ്റെ പേര് ലെഷ, ഞാൻ ആൽഫ-ബാങ്കിൻ്റെ ഉൽപ്പന്ന ടീമുകളിലൊന്നിൻ്റെ സിസ്റ്റം അനലിസ്റ്റാണ്. ഇപ്പോൾ ഞാൻ നിയമപരമായ സ്ഥാപനങ്ങൾക്കും വ്യക്തിഗത സംരംഭകർക്കും വേണ്ടി ഒരു പുതിയ ഓൺലൈൻ ബാങ്ക് വികസിപ്പിക്കുകയാണ്.

നിങ്ങൾ ഒരു അനലിസ്റ്റ് ആയിരിക്കുമ്പോൾ, പ്രത്യേകിച്ച് അത്തരമൊരു ചാനലിൽ, ഡോക്യുമെൻ്റേഷനും അതുമായി അടുത്ത് പ്രവർത്തിക്കാതെയും നിങ്ങൾക്ക് എവിടെയും എത്താൻ കഴിയില്ല. കൂടാതെ ഡോക്യുമെൻ്റേഷൻ എപ്പോഴും ഒരുപാട് ചോദ്യങ്ങൾ ഉയർത്തുന്ന ഒന്നാണ്. എന്തുകൊണ്ടാണ് വെബ് ആപ്ലിക്കേഷൻ വിവരിക്കാത്തത്? സേവനം എങ്ങനെ പ്രവർത്തിക്കണമെന്ന് സ്പെസിഫിക്കേഷൻ സൂചിപ്പിക്കുന്നത് എന്തുകൊണ്ട്, പക്ഷേ അത് അങ്ങനെ പ്രവർത്തിക്കുന്നില്ല? എന്തുകൊണ്ടാണ് ഇത് എഴുതിയ രണ്ട് ആളുകൾക്ക് മാത്രം സ്പെസിഫിക്കേഷൻ മനസ്സിലാകുന്നത്?

എന്നിരുന്നാലും, വ്യക്തമായ കാരണങ്ങളാൽ ഡോക്യുമെൻ്റേഷൻ അവഗണിക്കാൻ കഴിയില്ല. ഞങ്ങളുടെ ജീവിതം എളുപ്പമാക്കുന്നതിന്, ഡോക്യുമെൻ്റേഷൻ്റെ ഗുണനിലവാരം വിലയിരുത്താൻ ഞങ്ങൾ തീരുമാനിച്ചു. ഞങ്ങൾ ഇത് എത്ര കൃത്യമായി ചെയ്തു, ഞങ്ങൾ എന്ത് നിഗമനങ്ങളിൽ എത്തിച്ചേർന്നു എന്നത് കട്ടിന് താഴെയാണ്.

ഡോക്യുമെൻ്റേഷൻ നിലവാരം

വാചകത്തിൽ "പുതിയ ഇൻ്റർനെറ്റ് ബാങ്ക്" നിരവധി ഡസൻ തവണ ആവർത്തിക്കാതിരിക്കാൻ, ഞാൻ NIB എഴുതും. ഇപ്പോൾ ഞങ്ങൾക്ക് ഒരു ഡസനിലധികം ടീമുകൾ സംരംഭകർക്കും നിയമപരമായ സ്ഥാപനങ്ങൾക്കുമായി NIB വികസിപ്പിക്കുന്നതിനായി പ്രവർത്തിക്കുന്നു. മാത്രമല്ല, അവ ഓരോന്നും ഒന്നുകിൽ ഒരു പുതിയ സേവനത്തിനോ വെബ് ആപ്ലിക്കേഷനോ വേണ്ടി സ്വന്തം ഡോക്യുമെൻ്റേഷൻ സൃഷ്ടിക്കുന്നു, അല്ലെങ്കിൽ നിലവിലുള്ളതിൽ മാറ്റങ്ങൾ വരുത്തുന്നു. ഈ സമീപനത്തിലൂടെ, ഡോക്യുമെൻ്റേഷൻ തത്വത്തിൽ ഉയർന്ന നിലവാരമുള്ളതായിരിക്കുമോ?

ഡോക്യുമെൻ്റേഷൻ്റെ ഗുണനിലവാരം നിർണ്ണയിക്കാൻ, ഞങ്ങൾ മൂന്ന് പ്രധാന സവിശേഷതകൾ തിരിച്ചറിഞ്ഞു.

1. അത് പൂർണ്ണമായിരിക്കണം. ഇത് ക്യാപ്റ്റൻ പോലെ തോന്നുന്നു, പക്ഷേ ശ്രദ്ധിക്കേണ്ടത് പ്രധാനമാണ്. നടപ്പിലാക്കിയ പരിഹാരത്തിൻ്റെ എല്ലാ ഘടകങ്ങളും ഇത് വിശദമായി വിവരിക്കണം.
2. അത് നിലവിലുള്ളതായിരിക്കണം. അതായത്, പരിഹാരത്തിൻ്റെ നിലവിലെ നിർവ്വഹണവുമായി പൊരുത്തപ്പെടുന്നു.
3. അത് മനസ്സിലാക്കാവുന്നതായിരിക്കണം. അതിനാൽ അത് ഉപയോഗിക്കുന്ന വ്യക്തിക്ക് പരിഹാരം എങ്ങനെ നടപ്പിലാക്കുന്നുവെന്ന് കൃത്യമായി മനസ്സിലാക്കുന്നു.

സംഗ്രഹിക്കാൻ - പൂർണ്ണവും കാലികവും മനസ്സിലാക്കാവുന്നതുമായ ഡോക്യുമെൻ്റേഷൻ.

വോട്ട്നേടൽ

ഡോക്യുമെൻ്റേഷൻ്റെ ഗുണനിലവാരം വിലയിരുത്തുന്നതിന്, നേരിട്ട് പ്രവർത്തിക്കുന്നവരെ അഭിമുഖം നടത്താൻ ഞങ്ങൾ തീരുമാനിച്ചു: NIB അനലിസ്റ്റുകൾ. "10 മുതൽ 1 വരെയുള്ള സ്കെയിലിൽ (പൂർണ്ണമായും വിയോജിക്കുന്നു - പൂർണ്ണമായും സമ്മതിക്കുന്നു)" എന്ന സ്കീം അനുസരിച്ച് 5 പ്രസ്താവനകൾ വിലയിരുത്താൻ പ്രതികരിക്കുന്നവരോട് ആവശ്യപ്പെട്ടു.

ഗുണപരമായ ഡോക്യുമെൻ്റേഷൻ്റെ സവിശേഷതകളും NIB രേഖകളെ സംബന്ധിച്ച സർവേ കമ്പൈലർമാരുടെ അഭിപ്രായവും പ്രസ്താവനകൾ പ്രതിഫലിപ്പിച്ചു.

1. NIB ആപ്ലിക്കേഷനുകൾക്കുള്ള ഡോക്യുമെൻ്റേഷൻ കാലികവും അവ നടപ്പിലാക്കുന്നതിനോട് പൂർണ്ണമായും പൊരുത്തപ്പെടുന്നതുമാണ്.
2. NIB ആപ്ലിക്കേഷനുകൾ നടപ്പിലാക്കുന്നത് പൂർണ്ണമായി രേഖപ്പെടുത്തിയിട്ടുണ്ട്.
3. എൻഐബി ആപ്ലിക്കേഷനുകൾക്കുള്ള ഡോക്യുമെൻ്റേഷൻ ഫങ്ഷണൽ സപ്പോർട്ടിന് മാത്രമേ ആവശ്യമുള്ളൂ.
4. പ്രവർത്തന പിന്തുണയ്‌ക്കായി സമർപ്പിക്കുന്ന സമയത്ത് NIB ആപ്ലിക്കേഷനുകൾക്കുള്ള ഡോക്യുമെൻ്റേഷൻ നിലവിലുള്ളതാണ്.
5. NIB ആപ്ലിക്കേഷൻ ഡെവലപ്പർമാർ എന്താണ് നടപ്പിലാക്കേണ്ടതെന്ന് മനസിലാക്കാൻ ഡോക്യുമെൻ്റേഷൻ ഉപയോഗിക്കുന്നു.
6. NIB ആപ്ലിക്കേഷനുകൾ എങ്ങനെയാണ് നടപ്പിലാക്കുന്നത് എന്ന് മനസ്സിലാക്കാൻ മതിയായ ഡോക്യുമെൻ്റേഷൻ ഉണ്ട്.
7. NIB പ്രോജക്‌റ്റുകൾ അന്തിമമാക്കിയാൽ (എൻ്റെ ടീം) ഡോക്യുമെൻ്റേഷൻ ഞാൻ ഉടനടി അപ്‌ഡേറ്റ് ചെയ്യുന്നു.
8. NIB ആപ്ലിക്കേഷൻ ഡെവലപ്പർമാർ ഡോക്യുമെൻ്റേഷൻ അവലോകനം ചെയ്യുന്നു.
9. NIB പ്രോജക്റ്റുകൾക്കായി ഡോക്യുമെൻ്റേഷൻ തയ്യാറാക്കുന്നത് എങ്ങനെയെന്ന് എനിക്ക് വ്യക്തമായ ധാരണയുണ്ട്.
10. NIB പ്രോജക്‌റ്റുകൾക്കായി ഡോക്യുമെൻ്റേഷൻ എപ്പോൾ എഴുതണം/അപ്‌ഡേറ്റ് ചെയ്യണമെന്ന് ഞാൻ മനസ്സിലാക്കുന്നു.

“1 മുതൽ 5 വരെ” എന്ന് ഉത്തരം നൽകുന്നത് ആവശ്യമായ വിശദാംശങ്ങൾ വെളിപ്പെടുത്തിയേക്കില്ല, അതിനാൽ ഒരു വ്യക്തിക്ക് ഓരോ ഇനത്തിലും ഒരു അഭിപ്രായം രേഖപ്പെടുത്താം.

കോർപ്പറേറ്റ് സ്ലാക്ക് വഴിയാണ് ഞങ്ങൾ ഇതെല്ലാം ചെയ്തത് - ഒരു സർവേ നടത്താൻ ഞങ്ങൾ സിസ്റ്റം അനലിസ്റ്റുകൾക്ക് ഒരു ക്ഷണം അയച്ചു. 15 അനലിസ്റ്റുകൾ ഉണ്ടായിരുന്നു (9 മോസ്കോയിൽ നിന്നും 6 സെൻ്റ് പീറ്റേഴ്സ്ബർഗിൽ നിന്നും). സർവേ പൂർത്തിയാക്കിയ ശേഷം, ഞങ്ങൾ 10 പ്രസ്താവനകളിൽ ഓരോന്നിനും ശരാശരി സ്കോർ സൃഷ്ടിച്ചു, അത് ഞങ്ങൾ സ്റ്റാൻഡേർഡ് ചെയ്തു.

ഇതാണ് സംഭവിച്ചത്.

എൻഐബി ആപ്ലിക്കേഷനുകൾ നടപ്പിലാക്കുന്നത് പൂർണ്ണമായി രേഖപ്പെടുത്തിയിട്ടുണ്ടെന്ന് വിശകലന വിദഗ്ധർ വിശ്വസിക്കുന്നുണ്ടെങ്കിലും, അവർ അവ്യക്തമായ കരാർ നൽകുന്നില്ല (0.2). ഒരു നിർദ്ദിഷ്ട ഉദാഹരണമായി, നിലവിലുള്ള പരിഹാരങ്ങളിൽ നിന്നുള്ള നിരവധി ഡാറ്റാബേസുകളും ക്യൂകളും ഡോക്യുമെൻ്റേഷനിൽ ഉൾപ്പെടുന്നില്ലെന്ന് അവർ ചൂണ്ടിക്കാട്ടി. എല്ലാം രേഖപ്പെടുത്തപ്പെട്ടിട്ടില്ലെന്ന് വിശകലന വിദഗ്ധനോട് പറയാൻ ഡവലപ്പർക്ക് കഴിയും. എന്നാൽ ഡവലപ്പർമാർ ഡോക്യുമെൻ്റേഷൻ അവലോകനം ചെയ്യുന്ന പ്രബന്ധത്തിനും വ്യക്തമായ പിന്തുണ ലഭിച്ചില്ല (0.33). അതായത്, നടപ്പിലാക്കിയ പരിഹാരങ്ങളുടെ അപൂർണ്ണമായ വിവരണത്തിൻ്റെ അപകടസാധ്യത നിലനിൽക്കുന്നു.

പ്രസക്തി എളുപ്പമാണ് - വീണ്ടും വ്യക്തമായ ഉടമ്പടി ഇല്ലെങ്കിലും (0,13), വിശകലന വിദഗ്ധർ ഇപ്പോഴും പ്രസക്തമായ ഡോക്യുമെൻ്റേഷൻ പരിഗണിക്കാൻ ചായ്വുള്ളവരാണ്. പ്രസക്തമായ പ്രശ്നങ്ങൾ മധ്യഭാഗത്തേക്കാൾ മുൻവശത്താണെന്ന് മനസ്സിലാക്കാൻ അഭിപ്രായങ്ങൾ ഞങ്ങളെ അനുവദിച്ചു. എന്നിരുന്നാലും, പിന്തുണയെക്കുറിച്ച് അവർ ഞങ്ങൾക്ക് ഒന്നും എഴുതിയില്ല.

ഡോക്യുമെൻ്റേഷൻ എഴുതുകയും അപ്‌ഡേറ്റ് ചെയ്യുകയും ചെയ്യേണ്ടത് എപ്പോൾ ആവശ്യമാണെന്ന് വിശകലന വിദഗ്ധർ സ്വയം മനസ്സിലാക്കുന്നുണ്ടോ എന്ന കാര്യത്തിൽ, കരാർ അതിൻ്റെ ഡിസൈൻ (1,33) ഉൾപ്പെടെ കൂടുതൽ ഏകീകൃതമായിരുന്നു (1.07). ഡോക്യുമെൻ്റേഷൻ പരിപാലിക്കുന്നതിനുള്ള ഏകീകൃത നിയമങ്ങളുടെ അഭാവമാണ് ഇവിടെ ഒരു അസൗകര്യമായി രേഖപ്പെടുത്തിയത്. അതിനാൽ, “ആരാണ് കാട്ടിലേക്ക് പോകുന്നത്, ആർക്കാണ് വിറക് ലഭിക്കുന്നത്” മോഡ് ഓണാക്കാതിരിക്കാൻ, നിലവിലുള്ള ഡോക്യുമെൻ്റേഷൻ്റെ ഉദാഹരണങ്ങളെ അടിസ്ഥാനമാക്കി അവർ പ്രവർത്തിക്കേണ്ടതുണ്ട്. അതിനാൽ, ഡോക്യുമെൻ്റ് മാനേജ്മെൻ്റിനായി ഒരു മാനദണ്ഡം സൃഷ്ടിക്കുകയും അവയുടെ ഭാഗങ്ങൾക്കായി ടെംപ്ലേറ്റുകൾ വികസിപ്പിക്കുകയും ചെയ്യുക എന്നതാണ് ഉപയോഗപ്രദമായ ആഗ്രഹം.

പ്രവർത്തന പിന്തുണയ്‌ക്കായി സമർപ്പിക്കുന്ന സമയത്ത് NIB ആപ്ലിക്കേഷനുകൾക്കുള്ള ഡോക്യുമെൻ്റേഷൻ നിലവിലുള്ളതാണ് (0.73). ഇത് മനസ്സിലാക്കാവുന്നതേയുള്ളൂ, കാരണം പ്രവർത്തന പിന്തുണയ്‌ക്കായി ഒരു പ്രോജക്റ്റ് സമർപ്പിക്കുന്നതിനുള്ള മാനദണ്ഡങ്ങളിലൊന്ന് കാലികമായ ഡോക്യുമെൻ്റേഷനാണ്. ചില സമയങ്ങളിൽ ചോദ്യങ്ങൾ അവശേഷിക്കുന്നുണ്ടെങ്കിലും, നടപ്പാക്കൽ (0.67) മനസ്സിലാക്കാനും ഇത് മതിയാകും.

എന്നാൽ പ്രതികരിച്ചവർ അംഗീകരിക്കാത്തത് (തീർച്ചയായും ഏകകണ്ഠമായി) NIB ആപ്ലിക്കേഷനുകൾക്കുള്ള ഡോക്യുമെൻ്റേഷൻ, തത്വത്തിൽ, പ്രവർത്തനപരമായ പിന്തുണക്ക് മാത്രമേ ആവശ്യമുള്ളൂ (-1.53). ഡോക്യുമെൻ്റേഷൻ്റെ ഉപഭോക്താക്കൾ എന്ന നിലയിൽ അനലിസ്റ്റുകളെ മിക്കപ്പോഴും പരാമർശിച്ചിട്ടുണ്ട്. ബാക്കിയുള്ള ടീം അംഗങ്ങൾ (ഡെവലപ്പർമാർ) അങ്ങനെ ചെയ്യാനുള്ള സാധ്യത വളരെ കുറവാണ്. മാത്രമല്ല, ഏകകണ്ഠമായല്ലെങ്കിലും (-0.06) നടപ്പിലാക്കേണ്ടതെന്താണെന്ന് മനസിലാക്കാൻ ഡവലപ്പർമാർ ഡോക്യുമെൻ്റേഷൻ ഉപയോഗിക്കുന്നില്ലെന്ന് വിശകലന വിദഗ്ധർ വിശ്വസിക്കുന്നു. കോഡ് വികസനവും ഡോക്യുമെൻ്റേഷൻ എഴുത്തും സമാന്തരമായി നടക്കുന്ന സാഹചര്യങ്ങളിലും ഇത് പ്രതീക്ഷിക്കുന്നു.

എന്താണ് അടിസ്ഥാനം, എന്തുകൊണ്ടാണ് ഞങ്ങൾക്ക് ഈ നമ്പറുകൾ വേണ്ടത്?

പ്രമാണങ്ങളുടെ ഗുണനിലവാരം മെച്ചപ്പെടുത്തുന്നതിന്, ഇനിപ്പറയുന്നവ ചെയ്യാൻ ഞങ്ങൾ തീരുമാനിച്ചു:

1. രേഖാമൂലമുള്ള പ്രമാണങ്ങൾ അവലോകനം ചെയ്യാൻ ഡവലപ്പറോട് ആവശ്യപ്പെടുക.
2. സാധ്യമെങ്കിൽ, ഡോക്യുമെൻ്റേഷൻ സമയബന്ധിതമായി അപ്‌ഡേറ്റ് ചെയ്യുക, ആദ്യം മുന്നിൽ.
3. NIB പ്രോജക്‌റ്റുകൾ ഡോക്യുമെൻ്റുചെയ്യുന്നതിന് ഒരു സ്റ്റാൻഡേർഡ് സൃഷ്‌ടിക്കുകയും അവലംബിക്കുകയും ചെയ്യുക, അതുവഴി ഏതൊക്കെ സിസ്റ്റം ഘടകങ്ങളും കൃത്യമായി എങ്ങനെ വിവരിക്കണമെന്നും എല്ലാവർക്കും പെട്ടെന്ന് മനസ്സിലാക്കാൻ കഴിയും. ശരി, ഉചിതമായ ടെംപ്ലേറ്റുകൾ വികസിപ്പിക്കുക.

ഇതെല്ലാം പ്രമാണങ്ങളുടെ ഗുണനിലവാരം ഒരു പുതിയ തലത്തിലേക്ക് ഉയർത്താൻ സഹായിക്കും.

കുറഞ്ഞത് ഞാൻ അങ്ങനെ പ്രതീക്ഷിക്കുന്നു.

അവലംബം: www.habr.com