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