როგორ შევაფასეთ დოკუმენტაციის ხარისხი

გამარჯობა, ჰაბრ! მე მქვია ლეშა, ვარ სისტემის ანალიტიკოსი ალფა-ბანკის პროდუქტის ერთ-ერთი გუნდისთვის. ახლა ვავითარებ ახალ ონლაინ ბანკს იურიდიული და ინდივიდუალური მეწარმეებისთვის.

და როცა ანალიტიკოსი ხარ, განსაკუთრებით ასეთ არხზე, ვერსად წახვალ დოკუმენტაციისა და მასთან დაახლოების გარეშე. და დოკუმენტაცია არის ის, რაც ყოველთვის აჩენს უამრავ კითხვას. რატომ არ არის აღწერილი ვებ აპლიკაცია? რატომ მიუთითებს დაზუსტება, თუ როგორ უნდა იმუშაოს სერვისმა, მაგრამ ასე საერთოდ არ მუშაობს? რატომ ხდება, რომ მხოლოდ ორ ადამიანს, რომელთაგან ერთმა დაწერა, შეუძლია გაიგოს სპეციფიკაცია?

თუმცა, დოკუმენტაციის იგნორირება შეუძლებელია გასაგები მიზეზების გამო. და ჩვენი ცხოვრების გასაადვილებლად, გადავწყვიტეთ შეგვეფასებინა დოკუმენტაციის ხარისხი. ზუსტად როგორ გავაკეთეთ ეს და რა დასკვნამდე მივედით, ქვემოთ მოცემულია.

დოკუმენტაციის ხარისხი

იმისათვის, რომ "ახალი ინტერნეტ ბანკი" არ გავიმეორო ტექსტში რამდენჯერმე, დავწერ 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-მდე“ პასუხის გაცემამ შეიძლება არ გამოავლინოს საჭირო დეტალები, ამიტომ ადამიანს შეუძლია დატოვოს კომენტარი თითოეულ პუნქტზე.

ჩვენ ეს ყველაფერი გავაკეთეთ კორპორატიული Slack-ის მეშვეობით - ჩვენ უბრალოდ გავუგზავნეთ მოწვევა სისტემის ანალიტიკოსებს გამოკითხვის ჩასატარებლად. იყო 15 ანალიტიკოსი (9 მოსკოვიდან და 6 პეტერბურგიდან). გამოკითხვის დასრულების შემდეგ, ჩვენ გამოვიმუშავეთ საშუალო ქულა 10 დებულებიდან თითოეულისთვის, რომელიც შემდეგ მოვახდინეთ სტანდარტიზება.

ეს არის ის, რაც მოხდა.

კვლევამ აჩვენა, რომ მიუხედავად იმისა, რომ ანალიტიკოსები მიდრეკილნი არიან ირწმუნონ, რომ NIB აპლიკაციების განხორციელება სრულად არის დოკუმენტირებული, ისინი არ იძლევიან ცალსახა თანხმობას (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