మేము డాక్యుమెంటేషన్ నాణ్యతను ఎలా అంచనా వేసాము

హలో, హబ్ర్! నా పేరు లేషా, నేను ఆల్ఫా-బ్యాంక్ ఉత్పత్తి బృందాలలో ఒకదానికి సిస్టమ్స్ అనలిస్ట్‌ని. ఇప్పుడు నేను చట్టపరమైన సంస్థలు మరియు వ్యక్తిగత వ్యవస్థాపకుల కోసం కొత్త ఆన్‌లైన్ బ్యాంక్‌ని అభివృద్ధి చేస్తున్నాను.

మరియు మీరు విశ్లేషకుడిగా ఉన్నప్పుడు, ముఖ్యంగా అటువంటి ఛానెల్‌లో, డాక్యుమెంటేషన్ మరియు దానితో సన్నిహితంగా పని చేయకుండా మీరు ఎక్కడికీ వెళ్లలేరు. మరియు డాక్యుమెంటేషన్ అనేది ఎల్లప్పుడూ చాలా ప్రశ్నలను లేవనెత్తుతుంది. వెబ్ అప్లికేషన్ ఎందుకు వివరించబడలేదు? సేవ ఎలా పని చేయాలో స్పెసిఫికేషన్ ఎందుకు సూచిస్తుంది, కానీ అది అలా పని చేయదు? ఇది వ్రాసిన ఇద్దరు వ్యక్తులు మాత్రమే ఎందుకు వివరణను అర్థం చేసుకోగలరు?

అయినప్పటికీ, స్పష్టమైన కారణాల వల్ల డాక్యుమెంటేషన్ విస్మరించబడదు. మరియు మా జీవితాన్ని సులభతరం చేయడానికి, మేము డాక్యుమెంటేషన్ నాణ్యతను అంచనా వేయాలని నిర్ణయించుకున్నాము. మేము దీన్ని ఎలా సరిగ్గా చేసాము మరియు మేము ఏ తీర్మానాలకు వచ్చాము అనేది కట్ క్రింద ఉంది.

డాక్యుమెంటేషన్ నాణ్యత

టెక్స్ట్‌లో “న్యూ ఇంటర్నెట్ బ్యాంక్” అనేక డజన్ల సార్లు పునరావృతం కాకుండా ఉండటానికి, నేను NIB వ్రాస్తాను. ఇప్పుడు మేము వ్యవస్థాపకులు మరియు చట్టపరమైన సంస్థల కోసం NIB అభివృద్ధిపై పని చేస్తున్న డజనుకు పైగా బృందాలను కలిగి ఉన్నాము. అంతేకాకుండా, వాటిలో ప్రతి ఒక్కటి మొదటి నుండి కొత్త సేవ లేదా వెబ్ అప్లికేషన్ కోసం దాని స్వంత డాక్యుమెంటేషన్‌ను సృష్టిస్తుంది లేదా ప్రస్తుతానికి మార్పులు చేస్తుంది. ఈ విధానంతో, సూత్రప్రాయంగా డాక్యుమెంటేషన్ అధిక నాణ్యతతో ఉండవచ్చా?

మరియు డాక్యుమెంటేషన్ నాణ్యతను నిర్ణయించడానికి, మేము మూడు ప్రధాన లక్షణాలను గుర్తించాము.

1. ఇది పూర్తిగా ఉండాలి. ఇది కెప్టెన్ లాగా అనిపిస్తుంది, కానీ ఇది గమనించడం ముఖ్యం. ఇది అమలు చేయబడిన పరిష్కారం యొక్క అన్ని అంశాలను వివరంగా వివరించాలి.
2. ఇది సంబంధితంగా ఉండాలి. అంటే, పరిష్కారం యొక్క ప్రస్తుత అమలుకు అనుగుణంగా ఉంటుంది.
3. అర్థమయ్యేలా ఉండాలి. తద్వారా పరిష్కారం ఎలా అమలు చేయబడుతుందో దానిని ఉపయోగించే వ్యక్తి ఖచ్చితంగా అర్థం చేసుకుంటాడు.

సంగ్రహించేందుకు - పూర్తి, తాజా మరియు అర్థమయ్యే డాక్యుమెంటేషన్.

ఇంటర్వ్యూ

డాక్యుమెంటేషన్ నాణ్యతను అంచనా వేయడానికి, మేము దానితో నేరుగా పనిచేసే వారిని ఇంటర్వ్యూ చేయాలని నిర్ణయించుకున్నాము: NIB విశ్లేషకులు. "10 నుండి 1 వరకు (పూర్తిగా అంగీకరించలేదు - పూర్తిగా అంగీకరిస్తున్నారు)" పథకం ప్రకారం 5 స్టేట్‌మెంట్‌లను మూల్యాంకనం చేయమని ప్రతివాదులు కోరారు.

స్టేట్‌మెంట్‌లు గుణాత్మక డాక్యుమెంటేషన్ యొక్క లక్షణాలను మరియు NIB డాక్యుమెంట్‌లకు సంబంధించి సర్వే కంపైలర్‌ల అభిప్రాయాన్ని ప్రతిబింబిస్తాయి.

1. NIB అప్లికేషన్‌ల డాక్యుమెంటేషన్ తాజాగా ఉంది మరియు వాటి అమలుకు పూర్తిగా అనుగుణంగా ఉంది.
2. NIB అప్లికేషన్ల అమలు పూర్తిగా డాక్యుమెంట్ చేయబడింది.
3. ఫంక్షనల్ మద్దతు కోసం మాత్రమే NIB అప్లికేషన్‌ల కోసం డాక్యుమెంటేషన్ అవసరం.
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) ఉంది. డాక్యుమెంటేషన్ నిర్వహించడానికి ఏకరీతి నియమాలు లేకపోవడం ఇక్కడ అసౌకర్యంగా గుర్తించబడింది. అందువల్ల, "ఎవరు అడవికి వెళతారు, ఎవరు కట్టెలు పొందుతారు" మోడ్‌ను ఆన్ చేయకుండా ఉండటానికి, వారు ఇప్పటికే ఉన్న డాక్యుమెంటేషన్ యొక్క ఉదాహరణల ఆధారంగా పని చేయాలి. అందువల్ల, పత్ర నిర్వహణ కోసం ఒక ప్రమాణాన్ని సృష్టించడం మరియు వాటి భాగాల కోసం టెంప్లేట్‌లను అభివృద్ధి చేయడం ఉపయోగకరమైన కోరిక.

ఫంక్షనల్ సపోర్ట్ (0.73) కోసం సమర్పించే సమయంలో NIB అప్లికేషన్‌ల కోసం డాక్యుమెంటేషన్ ప్రస్తుతమున్నది. ఇది అర్థమయ్యేలా ఉంది, ఎందుకంటే ఫంక్షనల్ మద్దతు కోసం ప్రాజెక్ట్‌ను సమర్పించే ప్రమాణాలలో ఒకటి తాజా డాక్యుమెంటేషన్. కొన్నిసార్లు ప్రశ్నలు మిగిలి ఉన్నప్పటికీ, అమలు (0.67) అర్థం చేసుకోవడం కూడా సరిపోతుంది.

కానీ ప్రతివాదులు అంగీకరించనిది (చాలా ఏకగ్రీవంగా) NIB అప్లికేషన్‌ల కోసం డాక్యుమెంటేషన్, సూత్రప్రాయంగా, ఫంక్షనల్ మద్దతు కోసం మాత్రమే అవసరం (-1.53). విశ్లేషకులు చాలా తరచుగా డాక్యుమెంటేషన్ వినియోగదారులుగా పేర్కొనబడ్డారు. మిగిలిన బృందం (డెవలపర్లు) - చాలా తక్కువ తరచుగా. అంతేకాకుండా, డెవలపర్లు ఏకాభిప్రాయంతో కానప్పటికీ (-0.06) అమలు చేయాల్సిన వాటిని అర్థం చేసుకోవడానికి డాక్యుమెంటేషన్‌ను ఉపయోగించరని విశ్లేషకులు భావిస్తున్నారు. కోడ్ డెవలప్‌మెంట్ మరియు డాక్యుమెంటేషన్ రాయడం సమాంతరంగా కొనసాగే పరిస్థితుల్లో కూడా ఇది ఆశించబడుతుంది.

బాటమ్ లైన్ ఏమిటి మరియు మనకు ఈ సంఖ్యలు ఎందుకు అవసరం?

పత్రాల నాణ్యతను మెరుగుపరచడానికి, మేము ఈ క్రింది వాటిని చేయాలని నిర్ణయించుకున్నాము:

1. వ్రాతపూర్వక పత్రాలను సమీక్షించమని డెవలపర్‌ని అడగండి.
2. వీలైతే, ముందుగా డాక్యుమెంటేషన్‌ను సకాలంలో అప్‌డేట్ చేయండి.
3. NIB ప్రాజెక్ట్‌లను డాక్యుమెంట్ చేయడానికి ఒక ప్రమాణాన్ని సృష్టించండి మరియు అనుసరించండి, తద్వారా ప్రతి ఒక్కరూ ఏ సిస్టమ్ ఎలిమెంట్‌లను మరియు ఎలా సరిగ్గా వివరించాలో త్వరగా అర్థం చేసుకోగలరు. బాగా, తగిన టెంప్లేట్‌లను అభివృద్ధి చేయండి.

ఇవన్నీ పత్రాల నాణ్యతను కొత్త స్థాయికి పెంచడంలో సహాయపడతాయి.

కనీసం నేను ఆశిస్తున్నాను.

మూలం: www.habr.com