Yaxşı proqram sənədləri, istər proqramçılar və sınaqçılar üçün spesifikasiya sənədləri, istər daxili istifadəçilər üçün texniki sənədlər, istərsə də son istifadəçilər üçün dərsliklər və yardım sənədləri olsun, istifadəçilərə proqramın xüsusiyyətlərini və funksiyalarını anlamağa kömək edəcək. Yaxşı sənədləşmə, istifadəçinin ehtiyac duyduğu bütün məlumatlarla birlikdə spesifik, aydın və uyğun sənədlərdir. Bu məqalə texniki istifadəçilər və son istifadəçilər üçün proqram sənədləri yazmaq üçün sizə yol göstərəcək.
Addım
Metod 1 /2: Texniki İstifadəçilər üçün Proqram Sənədlərinin Yazılması
Addım 1. Hansı məlumatların daxil ediləcəyini bilin
Spesifikasiya sənədi, interfeys dizaynerləri, kod yazan proqramçılar və proqram performansını yoxlayan testçilər üçün istinad kitabçası kimi istifadə olunur. Daxil edilməli olan məlumatlar yaradılan proqramdan asılı olacaq, lakin aşağıdakıları ehtiva edə bilər:
- İnkişaf qrupu tərəfindən yaradılan fayllar, proqram işləyərkən əldə edilən məlumat bazaları və üçüncü tərəf tətbiqləri kimi tətbiqdəki vacib sənədlər.
- Funksiyanın/alt proqramın, giriş və çıxış dəyərlərinin istifadəsinin izahı da daxil olmaqla funksiyalar və alt proqramlar.
- Proqram dəyişənləri və sabitləri və necə istifadə edildiyi.
- Ümumi proqram quruluşu. Sürücüyə əsaslanan proqramlar üçün hər bir modulu və kitabxananı təsvir etməyiniz lazım ola bilər. Və ya veb əsaslı bir proqram üçün bir təlimat yazırsınızsa, hər səhifənin hansı fayllardan istifadə etdiyini izah etməyiniz lazım ola bilər.
Addım 2. Sənədlərin hansı səviyyədə olması və proqram kodundan ayrılmalı olduğuna qərar verin
Proqram koduna nə qədər çox texniki sənəd daxil edilərsə, onu yeniləmək və saxlamaq, həmçinin proqramın fərqli versiyalarını izah etmək daha asan olacaq. Ən azı proqram kodundakı sənədlər funksiyaların, alt proqramların, dəyişənlərin və sabitlərin istifadəsini ehtiva etməlidir.
- Mənbə kodunuz uzunsa, sənədləri kömək faylına yaza bilərsiniz, sonra indeksləşdirilə və ya müəyyən açar sözlərlə axtarıla bilər. Ayrı sənəd sənədləri, proqram məntiqi bir neçə səhifəyə bölündükdə və veb proqramı kimi dəstək sənədlərini ehtiva etdikdə faydalıdır.
- Bəzi proqramlaşdırma dillərinin (Java, Visual Basic. NET və ya C#kimi) öz kod sənədləşdirmə standartları var. Belə hallarda, mənbə koduna daxil edilməli olan standart sənədlərə əməl edin.
Addım 3. Müvafiq sənədləşdirmə vasitəsini seçin
Bəzi hallarda sənədləşdirmə vasitəsi istifadə olunan proqramlaşdırma dili ilə müəyyən edilir. C ++, C#, Visual Basic, Java, PHP və digər dillərin öz sənədləşdirmə vasitələri var. Ancaq bu edilmədikdə, istifadə olunan vasitələr tələb olunan sənədlərdən asılı olacaq.
- Sənədlər qısa və sadə olduğu müddətdə, Microsoft Word kimi bir söz prosessoru sənəd mətn faylları yaratmaq üçün uyğundur. Mürəkkəb mətnlə uzun sənədlər yaratmaq üçün əksər texniki yazıçılar Adobe FrameMaker kimi xüsusi sənədləşdirmə vasitələrini seçirlər.
- Mənbə kodunu sənədləşdirmək üçün kömək sənədləri RoboHelp, Help and Manual, Doc-To-Help, MadCap Flare və ya HelpLogix kimi bir dəstək fayl generatoru proqramı ilə yaradıla bilər.
Metod 2 /2: Son İstifadəçilər üçün Proqram Sənədlərinin Yazılması
Addım 1. Təlimatın yaradılmasının əsasını qoyan iş səbəblərini bilin
Proqram sənədləşməsinin əsas səbəbi istifadəçilərə tətbiqin necə istifadə ediləcəyini anlamalarına kömək etmək olsa da, marketinq şöbəsinin tətbiqin satışına kömək etməsi, şirkətin imicinin yaxşılaşdırılması və texniki dəstəyin azaldılması kimi sənədlərin yaradılmasının əsasını təşkil edə biləcək bir neçə başqa səbəb var. xərclər. Bəzi hallarda, sənədlərin qaydalara və ya digər qanuni tələblərə uyğun olması tələb olunur.
Ancaq sənədlər bir interfeys üçün yaxşı bir əvəz deyil. Bir tətbiqin işləməsi üçün çoxlu sənədlər tələb olunarsa, daha intuitiv şəkildə hazırlanmalıdır
Addım 2. Sənədlərin hədəf auditoriyasını bilin
Ümumiyyətlə, proqram istifadəçiləri istifadə etdikləri tətbiqlərdən kənarda məhdud kompüter biliklərinə sahibdirlər. Sənəd ehtiyaclarını ödəmək üçün bir neçə yol var:
- Proqram istifadəçisinin adına diqqət yetirin. Məsələn, sistem idarəçisi ümumiyyətlə müxtəlif kompüter proqramlarını başa düşür, katib isə yalnız məlumat daxil etmək üçün istifadə etdiyi tətbiqləri bilir.
- Proqram istifadəçilərinə diqqət yetirin. Vəzifələri ümumiyyətlə yerinə yetirilən vəzifələrlə uyğun olsa da, bu vəzifələr iş yerindən asılı olaraq fərqli iş yüklərinə malik ola bilər. Potensial istifadəçilərdən müsahibə alaraq, onların vəzifə adı ilə bağlı qiymətləndirmələrinizin doğru olub olmadığını öyrənə bilərsiniz.
- Mövcud sənədlərə diqqət yetirin. Proqram funksionallığı sənədləri və xüsusiyyətləri istifadəçilərin onlardan istifadə etmək üçün nələri bilməli olduğunu göstərə bilər. Ancaq unutmayın ki, istifadəçilər proqramın "iç üzlərini" bilməklə maraqlana bilməzlər.
- Bir işi başa çatdırmaq üçün nəyin lazım olduğunu və onu tamamlamadan əvvəl nə lazım olduğunu bilin.
Addım 3. Sənədləşmə üçün uyğun formatı müəyyənləşdirin
Proqram sənədləri 1 və ya 2 formatda, yəni istinad kitabları və dərsliklər şəklində təşkil edilə bilər. Bəzən iki formatı birləşdirmək yaxşı bir həlldir.
- İstinad formatları düymələr, nişanlar, sahələr və informasiya qutuları kimi bütün proqram xüsusiyyətlərini və necə işlədiyini təsvir etmək üçün istifadə olunur. Bəzi yardım sənədləri, xüsusən kontekstə həssas olanlar bu formatda yazılır. İstifadəçi müəyyən bir ekranda Kömək düyməsini kliklədikdə istifadəçi müvafiq mövzunu alacaq.
- Manual format, proqramla bir şeyin necə ediləcəyini izah etmək üçün istifadə olunur. Təlimatlar ümumiyyətlə çap və ya PDF formatındadır, baxmayaraq ki, bəzi yardım səhifələrində müəyyən işlərin necə aparılacağına dair təlimatlar da var. (Ümumiyyətlə, əl formatları kontekstə həssas deyildir, lakin kontekstə həssas mövzulardan əlaqələndirilə bilər). Əl kitabları ümumiyyətlə bir bələdçi formasındadır, təsvirdə yerinə yetiriləcək vəzifələrin xülasəsi və addımlarla formatlanmış bir bələdçi.
Addım 4. Sənədlərin növünə qərar verin
İstifadəçilər üçün proqram sənədləri aşağıdakı formatlardan birində və ya bir neçəsində qablaşdırıla bilər: çap edilmiş dərsliklər, PDF sənədləri, yardım sənədləri və ya onlayn yardım. Hər bir sənəd növü, bir bələdçi və ya bir dərs olsun, proqramın funksiyalarını necə istifadə edəcəyinizi göstərmək üçün hazırlanmışdır. Onlayn sənədlər və yardım səhifələrində nümayiş videoları, mətn və statik şəkillər də ola bilər.
İstifadəçilər ehtiyac duyduqları məlumatı tez tapa bilmələri üçün onlayn yardım və dəstək sənədləri açar sözlərdən istifadə edərək indekslənməli və axtarıla bilər. Bir yardım faylı generatoru tətbiqi avtomatik olaraq bir indeks yarada bilsə də, yenə də çox axtarılan açar sözlərdən istifadə edərək indeksi əl ilə yaratmağınız məsləhətdir
Addım 5. Müvafiq sənədləşdirmə vasitəsini seçin
Çap edilmiş dərsliklər və ya PDF sənədlərin uzunluğu və mürəkkəbliyindən asılı olaraq Word kimi bir söz işləmə proqramı və ya FrameMaker kimi inkişaf etmiş bir mətn redaktoru ilə yaradıla bilər. Yardım faylları RoboHelp, Help and Manual, Doc-To-Help, Flare, HelpLogix və ya HelpServer kimi bir yardım faylı yaratmaq proqramı ilə yazıla bilər.
İpuçları
- Proqram sənədlərinin mətni oxunması asan olacaq şəkildə qurulmalıdır. Təsviri mümkün qədər uyğun mətnə yaxın qoyun. Sənədləri məntiqlə bölmələrə və mövzulara bölün. Hər bir bölmə və ya mövzu müəyyən bir problemi, həm tapşırıq, həm də proqram xüsusiyyətlərini təsvir etməlidir. Əlaqəli məsələlər bağlantılar və ya istinad siyahıları ilə izah edilə bilər.
- Bu yazıda təsvir olunan sənədləşdirmə vasitələrinin hər biri, sənədləriniz birdən çox ekran görüntüsü tələb edərsə, SnagIt kimi bir ekran görüntüsü istehsalçısı proqramı ilə tamamlana bilər. Hər hansı digər sənədlər kimi, istifadəçini "cəlb etmək" əvəzinə tətbiqin necə işlədiyini izah etmək üçün ekran görüntüləri də əlavə etməlisiniz.
- Xüsusilə son istifadəçilər üçün proqram sənədləri yazırsınızsa, üsluba diqqət yetirmək çox vacibdir. İstifadəçilərə "istifadəçi" əvəzinə "siz" əvəzliyi ilə müraciət edin.
