დოკუმენტაციის სახელმძღვანელო პრინციპები

ეს სახელმძღვანელო აღწერს სტანდარტებსა და საუკეთესო პრაქტიკებს ICMS ცოდნის ჰაბში დოკუმენტაციის შექმნისა და შენახვისთვის.

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

ყველა დოკუმენტაცია უნდა შეესაბამებოდეს თანმიმდევრულ სტრუქტურას:

1. სათაური - მკაფიო და აღწერილობითი
2. მიმოხილვა - დოკუმენტის მიზნისა და შინაარსის მოკლე შეჯამება
3. წინაპირობები - აუცილებელი ცოდნა ან რესურსები
4. ძირითადი შინაარსი - ორგანიზებული ლოგიკურ სექციებად მკაფიო სათაურებით
5. წყაროები - ბმულები დაკავშირებულ რესურსებზე
6. ცვლილებების ისტორია - ძირითადი ცვლილებების ჩანაწერი

წერის სტილი

მიჰყევით ამ წერის სახელმძღვანელოებს:

• გამოიყენეთ მკაფიო, ლაკონური ენა
• წერეთ აქტიური ხმით
• განსაზღვრეთ აკრონიმები პირველი გამოყენებისას
• გამოიყენეთ დანომრილი სიები თანმიმდევრული ნაბიჯებისთვის
• გამოიყენეთ მარკერებიანი სიები არათანმიმდევრული ელემენტებისთვის

ფორმატირების სახელმძღვანელოები

სათაურები

გამოიყენეთ სათაურების სწორი იერარქია (H1, H2, H3) დოკუმენტის სტრუქტურისთვის:

1# H1 - დოკუმენტის სათაური
2## H2 - ძირითადი განყოფილება
3### H3 - ქვეგანყოფილება

კოდის ბლოკები

დააფორმატეთ კოდის ნიმუშები შემოღობილი კოდის ბლოკების გამოყენებით შესაბამისი ენის სპეციფიკაციით:

1def example_function():
2    print("ეს არის მაგალითის ფუნქცია")
3    return True

ცხრილები

გამოიყენეთ ცხრილები სტრუქტურირებული მონაცემებისთვის:

სურათები

სახელმძღვანელო სურათების გამოყენებისთვის:

1. გამოიყენეთ აღწერილობითი ფაილის სახელები
2. ჩართეთ ალტერნატიული ტექსტი ხელმისაწვდომობისთვის
3. ოპტიმიზაცია გაუკეთეთ სურათებს ინტერნეტისთვის (კომპრესია)
4. გამოიყენეთ ეკრანის ანაბეჭდები მხოლოდ საჭიროების შემთხვევაში
5. დაამატეთ წარწერები სიცხადისთვის

დოკუმენტის მოვლა

რეგულარული მოვლა ინარჩუნებს დოკუმენტაციის ღირებულებას:

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

შაბლონები

სტანდარტული შაბლონები ხელმისაწვდომია:

• ტექნიკური სახელმძღვანელოები
• პროცესის დოკუმენტაცია
• საცნობარო მასალები
• დიაგნოსტიკის სახელმძღვანელოები

საბოლოო მიმოხილვის საკონტროლო სია

გამოქვეყნებამდე, დარწმუნდით, რომ თქვენი დოკუმენტი:

• აქვს მკაფიო სათაური და აღწერა
• შეიცავს ზუსტ ტექნიკურ ინფორმაციას
• სწორად არის კატეგორიზებული და მარკირებული
• არის კორექტირებული გრამატიკისა და სიცხადისთვის
• მოიცავს შესაბამის ბმულებს დაკავშირებულ შინაარსზე
• განხილულია საგნის ექსპერტის მიერ

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