Transformers-ის დოკუმენტაციის დღევანდელი ძირითადი ვერსია მნიშვნელოვნად განსხვავდება 3 წლის წინანდელი, 4.10.0 ვერსიისგან. მას შემდეგ, რაც Transformer მოდელები ხელოვნური ინტელექტის (AI) მიდგომის სტანდარტულ მეთოდად იქცა, დოკუმენტაცია არსებითად გაფართოვდა, რათა მოიცავდეს ახალ მოდელებსა და გამოყენების ახალ სქემებს. თუმცა, ახალი შინაარსი ემატებოდა ეტაპობრივად, სათანადოდ არ იყო გათვალისწინებული, თუ როგორ განვითარდა აუდიტორია და თავად Transformers-ის ბიბლიოთეკა. ვფიქრობ, სწორედ ამიტომ არის დოკუმენტაციასთან მუშაობის გამოცდილება (DocX) არათანმიმდევრული, სანავიგაციოდ რთული და მოძველებული. ფაქტობრივად, სრული არეულობაა. სწორედ ამიტომ გახდა Transformers-ის დოკუმენტაციის რედიზაინი აუცილებელი ამ არეულობის მოსაწესრიგებლად. მიზანია: ჩვენი აზრით, ის კომპანიები, რომლებიც გააცნობიერებენ, რომ ხელოვნური ინტელექტი არ არის მხოლოდ ინტეგრირებული API-ები, არამედ ახალი პარადიგმაა ყველა ტექნოლოგიის შესაქმნელად და რომლებიც შიდა რესურსებით განავითარებენ ამ „კუნთს“ (ანუ შექმნიან და გაავარჯიშებენ საკუთარ მოდელებს), შეძლებენ სხვებზე 100-ჯერ უკეთესი პროდუქტის შექმნას და მოიპოვებენ განსხვავებულობასა და გრძელვადიან ღირებულებას. Transformers-ის დოკუმენტაცია თავდაპირველად მანქანური სწავლების ინჟინრებისა და მკვლევრებისთვის, ასევე მოდელების მოყვარულებისთვის იყო შექმნილი. ახლა, როდესაც ხელოვნური ინტელექტი უფრო მეინსტრიმული და მომწიფებულია და აღარ არის მხოლოდ დროებითი გატაცება, დეველოპერები სულ უფრო მეტად ინტერესდებიან, თუ როგორ ჩართონ ხელოვნური ინტელექტი პროდუქტებში. ეს ნიშნავს იმის გაცნობიერებას, რომ დეველოპერები დოკუმენტაციასთან განსხვავებულად ურთიერთობენ, ვიდრე მანქანური სწავლების ინჟინრები და მკვლევრები. არსებობს ორი ძირითადი განსხვავება: რედიზაინის შემდეგ, Transformers-ის დოკუმენტაცია უფრო მეტად იქნება კოდზე ორიენტირებული და გადაწყვეტილებებისკენ მიმართული. კოდი და მანქანური სწავლების დამწყები კონცეფციების ახსნა მჭიდროდ იქნება დაკავშირებული, რათა უზრუნველყოფილი იყოს უფრო სრული და დამწყებთათვის მეგობრული გაცნობის გამოცდილება. მას შემდეგ, რაც დეველოპერებს ექნებათ საბაზისო ცოდნა, მათ შეუძლიათ თანდათან გააღრმაონ თავიანთი ცოდნა Transformers-ის შესახებ. Hugging Face-ში ჩემი ერთ-ერთი პირველი პროექტი იყო Transformers-ის დოკუმენტაციის Diátaxis-თან შესაბამისობაში მოყვანა. Diátaxis არის დოკუმენტაციის მიდგომა, რომელიც მომხმარებლის საჭიროებებს ეფუძნება (სწავლა, პრობლემის გადაჭრა, გაგება, ცნობარი). გამოქვეყნდა ახალი სახელი, ახალი შინაარსი, ახალი ვიზუალი და ახალი მისამართი. სავარაუდოდ, ეს მსოფლიოში საუკეთესო დოკუმენტაციის შექმნის სისტემაა! თუმცა, სადღაც გზაზე Diátaxis-ის გამოყენება, როგორც გეგმის, და არა როგორც სახელმძღვანელოს, დავიწყე. ვცდილობდი შინაარსი ზუსტად მომერგებინა 4 დადგენილ კატეგორიაში. ამ სიხისტემ ხელი შეუშალა ბუნებრივი შინაარსის სტრუქტურების გაჩენას და დოკუმენტაციას მოქნილად ადაპტაციასა და მასშტაბირებაში. ერთ თემაზე შექმნილი დოკუმენტაცია მალე რამდენიმე სექციაზე გაიშალა, რადგან ასე მოითხოვდა სტრუქტურა და არა იმიტომ, რომ ეს აზრიანი იყო. ნორმალურია, თუ სტრუქტურა რთულია, მაგრამ მიუღებელია, თუ ის რთულიცაა და მასში ორიენტაციაც შეუძლებელია. რედიზაინი სიხისტეს მოქნილობით შეცვლის, რათა დოკუმენტაციამ ზრდა და განვითარება შეძლოს. ხის წლიური რგოლები წარსულის კლიმატოლოგიურ ჩანაწერებს ინახავს (გვალვა, წყალდიდობა, ტყის ხანძარი და ა.შ.). გარკვეულწილად, Transformers-ის დოკუმენტაციასაც აქვს თავისი „წლიური რგოლები“ ანუ ეპოქები, რომლებიც მის ევოლუციას ასახავს: ყოველმა ეპოქამ თანდათანობით დაამატა ახალი შინაარსი დოკუმენტაციას, რამაც დაარღვია წინა ნაწილების ბალანსი და გააბუნდოვნა ისინი. შინაარსი გაფანტულია დიდ ზედაპირზე, ნავიგაცია უფრო რთულია. „წლიური რგოლების“ მოდელში ახალი შინაარსი თანდათანობით ეფინება წინა შინაარსს. ინტეგრირებულ მოდელში კი შინაარსი თანაარსებობს, როგორც მთლიანი დოკუმენტაციის ნაწილი. რედიზაინი ხელს შეუწყობს დოკუმენტაციასთან მუშაობის საერთო გამოცდილების დაბალანსებას. შინაარსი იგრძნობა ბუნებრივად და ინტეგრირებულად, ვიდრე უბრალოდ დამატებულად. ეს პოსტი იკვლევდა Transformers-ის დოკუმენტაციის რედიზაინის მიზეზებსა და მოტივაციას. დაელოდეთ შემდეგ პოსტს, რომელიც უფრო დეტალურად აღწერს არსებულ არეულობას და პასუხობს მნიშვნელოვან კითხვებს, როგორიცაა: ვინ არიან გამიზნული მომხმარებლები და დაინტერესებული მხარეები, როგორია შინაარსის ამჟამინდელი მდგომარეობა და როგორ ხდება მისი ინტერპრეტაცია. მადლობა evilpingwin-ს უკუკავშირისა და დოკუმენტაციის რედიზაინის მოტივაციისთვის. იხილეთ მეტი სტატია ჩვენს ბლოგზე · დარეგისტრირდით ან შეხვიდით კომენტარისთვის.