Proqram sənədləri sadəcə məqalələr toplusudur. Ancaq hətta onlar səni dəli edə bilərlər. Birincisi, lazımi təlimatları axtarmaq üçün uzun müddət sərf edirsiniz. Sonra qaranlıq mətni başa düşürsən. Yazdığınız kimi edirsiniz, amma problem həll olunmur. Başqa məqalə axtarırsan, əsəbləşirsən... Bir saat sonra hər şeydən əl çəkib gedirsən. Pis sənədlər belə işləyir. Bunu nə edir və onu necə düzəltmək olar - kəsik altında oxuyun.
Köhnə sənədlərimizdə çoxlu çatışmazlıqlar var idi. Artıq bir ilə yaxındır ki, yuxarıda təsvir edilən ssenari müştərilərimizə təsir etməmək üçün onu yenidən işləyirik. Bax, и .
Problem 1: Aydın olmayan, zəif yazılmış məqalələr
Əgər sənədləri başa düşmək mümkün deyilsə, bunun nə mənası var? Amma heç kim bilərəkdən anlaşılmaz yazılar yazmır. Müəllif auditoriya və məqsəd haqqında düşünməyəndə, su tökəndə, mətndə səhv olub-olmadığını yoxlamayanda baş verir.
- Tamaşaçılar. Məqalə yazmazdan əvvəl oxucunun hazırlıq səviyyəsini düşünmək lazımdır. Məntiqlidir ki, yeni başlayanlar üçün bir məqalədə əsas addımları atlamamalı və texniki terminləri izahatsız tərk etməməlisən, ancaq yalnız peşəkarlara lazım olan nadir xüsusiyyət haqqında məqalədə PHP sözünün mənasını izah etməlisiniz.
- Məqsəd. Əvvəlcədən düşünmək üçün başqa bir şey. Müəllif qarşısına dəqiq məqsəd qoymalı, məqalənin faydalı təsirini müəyyən etməli və oxucunun onu oxuduqdan sonra nə edəcəyinə qərar verməlidir. Bu edilmədikdə, təsvir xatirinə təsvirlə başa çatacaqsınız.
- Su və böcəklər. Çoxlu lazımsız məlumatlar var və bürokratiya, səhvlər və yazı səhvləri qavrayışa mane olur. Oxucu qrammatik nasist olmasa belə, mətndəki diqqətsizlik onu söndürə bilər.
Yuxarıdakı məsləhətləri nəzərdən keçirin və məqalələr daha aydın olacaq - zəmanətli. Daha da yaxşılaşdırmaq üçün bizim istifadə edin .
Problem 2. Məqalələr bütün suallara cavab vermir
Sənədləşmə inkişafa uyğun gəlmədikdə, real suallara cavab vermədikdə və ondakı səhvlər illərlə düzəldilmədikdə pisdir. Bunlar daha çox müəllifin deyil, şirkət daxilində proseslərin təşkili ilə bağlı problemlərdir.
Sənədləşmə inkişafa uyğun gəlmir
Funksiya artıq buraxılışdadır, marketinq onu əhatə etməyi planlaşdırır və sonra məlum olur ki, yeni məqalə və ya tərcümə hələ də sənədlərdə yoxdur. Hətta buna görə buraxılışı da təxirə salmalı olduq. Hər kəsdən tapşırıqları istədiyiniz qədər vaxtında texniki yazıçılara təhvil verməsini istəyə bilərsiniz, lakin bu, işləməyəcək. Proses avtomatlaşdırılmasa, vəziyyət təkrarlanacaq.
YouTrack-də dəyişikliklər etdik. Yeni bir xüsusiyyət haqqında məqalə yazmaq vəzifəsi xüsusiyyət sınaqdan keçirilməyə başladığı anda texniki yazıçının üzərinə düşür. Sonra marketinq təşviqə hazırlaşmaq üçün bu barədə öyrənir. Bildirişlər həmçinin Mattermost korporativ messencerinə gəlir, ona görə də tərtibatçılardan xəbərləri qaçırmaq mümkün deyil.
Sənədlər istifadəçi sorğularını əks etdirmir
Biz belə işləməyə öyrəşmişik: bir xüsusiyyət çıxdı, ondan danışdıq. Onu necə yandırmaq, söndürmək və incə tənzimləmələr etməyi təsvir etdik. Bəs müştəri bizim proqram təminatımızı gözləmədiyimiz şəkildə istifadə edərsə, necə? Yoxsa bizim düşünmədiyimiz səhvlər var?
Sənədlərin mümkün qədər tam olmasını təmin etmək üçün dəstək sorğularını, tematik forumlardakı sualları və axtarış sistemlərindəki sorğuları təhlil etməyi tövsiyə edirik. Ən populyar mövzular texniki yazıçılara ötürüləcək ki, onlar mövcud məqalələri əlavə edə və ya yeni məqalələr yaza bilsinlər.
Sənədləşmə təkmilləşdirilmir
Bunu dərhal mükəmməl etmək çətindir, hələ də səhvlər olacaq. Müştərilərin rəyinə ümid edə bilərsiniz, lakin onların hər bir yazı səhvi, qeyri-dəqiqlik, anlaşılmaz və ya əsassız məqalə haqqında məlumat verəcəyi ehtimalı azdır. Müştərilərə əlavə olaraq, işçilər sənədləri oxuyurlar, yəni eyni səhvləri görürlər. Bu istifadə edilə bilər! Sadəcə problemi bildirməyin asan olacağı şərait yaratmalısınız.
Bizim daxili portalda işçilər sənədlərlə bağlı şərhlər, təkliflər və ideyalar buraxan qrupumuz var. Dəstəyin məqaləyə ehtiyacı var, amma mövcud deyil? Sınaqçı qeyri-dəqiqliyi görübmü? Tərəfdaş inkişaf menecerlərinə səhvlərdən şikayət edibmi? Hamısı bu qrupda! Texniki yazıçılar bəzi şeyləri dərhal düzəldir, bəzi şeyləri YouTrack-ə köçürür və başqalarına düşünmək üçün vaxt verir. Mövzunun tükənməsinin qarşısını almaq üçün zaman-zaman qrupun varlığını və rəyin vacibliyini xatırladırıq.
Problem 3. Düzgün məqaləni tapmaq çox vaxt aparır.
Tapılmayan məqalə, tapılmayan məqalədən yaxşı deyil. Yaxşı sənədləşdirmənin şüarı “Axtarmaq asan, tapmaq asan” olmalıdır. Buna necə nail olmaq olar?
Strukturu təşkil edin və mövzuların seçilməsi prinsipini müəyyənləşdirin. Struktur mümkün qədər şəffaf olmalıdır ki, oxucu “Mən bu yazını haradan tapa bilərəm?” deyə düşünməsin. Xülasə etmək üçün iki yanaşma var: interfeysdən və tapşırıqlardan.
- İnterfeysdən. Məzmun panel bölmələrini təkrarlayır. Bu köhnə ISPsystem sənədlərində belə idi.
- Tapşırıqlardan. Məqalələrin və bölmələrin adları istifadəçilərin vəzifələrini əks etdirir; Başlıqlar demək olar ki, həmişə fellərdən və “necə?” sualına cavablardan ibarətdir. İndi biz bu formata keçirik.
Seçdiyiniz yanaşmadan asılı olmayaraq, mövzunun istifadəçilərin axtardıqlarına uyğun olduğundan və istifadəçinin sualına xüsusi cavab verən şəkildə əhatə olunduğundan əmin olun.
Mərkəzləşdirilmiş axtarış qurun. İdeal bir dünyada, hətta səhv yazdığınız zaman və ya dildə səhv etdiyiniz zaman da axtarış işləməlidir. İndiyə qədər Confluence-də apardığımız axtarışlar bizi bununla sevindirə bilməz. Çox məhsulunuz varsa və sənədlər ümumidirsə, axtarışı istifadəçinin olduğu səhifəyə uyğunlaşdırın. Bizim vəziyyətimizdə, əsas səhifədəki axtarış bütün məhsullar üçün işləyir və əgər siz artıq müəyyən bir bölmədəsinizsə, onda yalnız oradakı məqalələr üçün.
Məzmunu və çörək qırıntılarını əlavə edin. Hər səhifədə menyu və çörək qırıntıları olduqda yaxşıdır - istifadəçinin istənilən səviyyəyə qayıtmaq imkanı ilə cari səhifəyə gedən yolu. Köhnə ISPsystem sənədlərində məzmuna daxil olmaq üçün məqalədən çıxmalı idiniz. Əlverişsiz idi, ona görə də yenisində düzəltdik.
Linkləri məhsula yerləşdirin. İnsanlar təkrar-təkrar eyni sualla dəstək olmağa gəlirlərsə, interfeysə onun həlli ilə bağlı ipucu əlavə etmək mənasızdır. İstifadəçinin nə zaman problemlə üzləşdiyi barədə məlumatınız və ya məlumatınız varsa, onları poçt siyahısı ilə də xəbərdar edə bilərsiniz. Onlara qayğı göstərin və dəstək yükünü götürün.
Açılan pəncərənin sağ tərəfində ISPmanager-in domen idarəetmə bölməsində DNSSEC-in qurulması haqqında məqaləyə keçid var.
Sənədlər daxilində çarpaz istinadlar qurun. Bir-biri ilə əlaqəli məqalələr “əlaqələndirilməlidir”. Məqalələr ardıcıldırsa, hər mətnin sonunda irəli və geri oxları əlavə etməyi unutmayın.
Çox güman ki, insan əvvəlcə öz sualının cavabını sizə deyil, axtarış sisteminə gedəcək. Texniki səbəblərə görə orada sənədlərə heç bir keçid yoxdursa, ayıbdır. Beləliklə, axtarış motorunun optimallaşdırılmasına diqqət yetirin.
Problem 4. Köhnəlmiş tərtibat qavrayışa mane olur
Pis mətnlərə əlavə olaraq, sənədlər dizayn tərəfindən korlana bilər. İnsanlar yaxşı yazılmış materialları oxumağa öyrəşiblər. Bloqlar, sosial şəbəkələr, media - bütün məzmunlar təkcə gözəl deyil, həm də asan oxunan və gözə xoş gələn təqdim olunur. Buna görə də, aşağıdakı ekran görüntüsündə olduğu kimi mətni görən bir insanın ağrısını asanlıqla başa düşə bilərsiniz.
Bu məqalədə o qədər çox skrinşot və məqam var ki, onlar kömək etmir, ancaq qavrayışa mane olur (şəkil tıklanabilir)
Bir çox effektləri olan sənədlərdən uzun müddət oxumamalısınız, ancaq əsas qaydaları nəzərə almalısınız.
Layout. Bədən mətninin genişliyini, şriftini, ölçüsünü, başlıqlarını və doldurulmasını müəyyənləşdirin. Bir dizayner işə götürün və işi qəbul etmək və ya özünüz etmək üçün Artyom Qorbunovun “Tipoqrafiya və tərtibat” kitabını oxuyun. O, planın yalnız bir görünüşünü təqdim edir, lakin kifayət qədərdir.
Ayrışmalar. Mətndə nəyin vurğulandığını müəyyənləşdirin. Tipik olaraq bu, interfeysdəki yol, düymələr, kod əlavələri, konfiqurasiya faylları, "Qeyd edin" bloklarıdır. Bu elementlərin necə bölüşdürüləcəyini müəyyənləşdirin və onları reqlamentdə qeyd edin. Nəzərə alın ki, boşalma nə qədər az olsa, bir o qədər yaxşıdır. Onların sayı çox olanda mətn səs-küylü olur. Hətta dırnaq işarələri çox tez-tez istifadə edildikdə səs-küy yaradır.
Screenshots. Hansı hallarda ekran görüntülərinin lazım olduğu komanda ilə razılaşın. Hər addımı təsvir etməyə mütləq ehtiyac yoxdur. Çox sayda ekran görüntüsü, o cümlədən. düymələri ayırır, qavrayışa müdaxilə edir, tərtibatı korlayır. Ekran görüntülərində vurğulanan məqamların və imzaların ölçüsünü, həmçinin formatını müəyyənləşdirin və reqlamentdə qeyd edin. Unutmayın ki, illüstrasiyalar həmişə yazılanlara uyğun olmalıdır və müvafiq olmalıdır. Yenə məhsul müntəzəm olaraq yenilənirsə, hər kəsi izləmək çətin olacaq.
Mətn uzunluğu. Həddindən artıq uzun məqalələrdən çəkinin. Onları hissələrə bölün və bu mümkün deyilsə, məqalənin əvvəlinə lövbər bağlantıları olan məzmun əlavə edin. Məqaləni vizual olaraq qısaltmağın sadə yolu dar bir oxucu dairəsi üçün lazım olan texniki detalları spoyler altında gizlətməkdir.
Formatlar. Məqalələrinizdə bir neçə formatı birləşdirin: mətn, video və şəkillər. Bu qavrayışı yaxşılaşdıracaq.
Problemləri gözəl tərtibatla ört-basdır etməyə çalışmayın. Düzünü desəm, biz özümüz ümid edirdik ki, “sarğı” köhnəlmiş sənədləri saxlayacaq - alınmadı. Mətnlərdə o qədər vizual səs-küy və lazımsız detallar var idi ki, qaydalar və yeni dizayn gücsüz idi.
Yuxarıda göstərilənlərin çoxu sənədlər üçün istifadə etdiyiniz platforma tərəfindən müəyyən ediləcək. Məsələn, bizdə Confluence var. Mən də onunla məşğul olmalıydım. Əgər maraqlanırsınızsa, veb tərtibatçımızın hekayəsini oxuyun: .
Təkmilləşdirməyə haradan başlamaq və necə yaşamaq lazımdır
Əgər sənədləriniz ISP sistemi qədər genişdirsə və haradan başlayacağınızı bilmirsinizsə, ən böyük problemlərdən başlayın. Müştərilər sənədi başa düşmürlər - mətnləri təkmilləşdirin, qaydalar hazırlayın, yazıçılar yetişdirin. Sənədləşmə vaxtı keçmişdir - daxili proseslərə diqqət yetirin. Ən populyar məhsullar haqqında ən populyar məqalələrlə başlayın: dəstək istəyin, axtarış motorlarında sayt analitikasına və sorğularına baxın.
Dərhal deyək - bu asan olmayacaq. Həm də tez işləmək mümkün deyil. Əgər siz yeni başlamısınızsa və dərhal doğru şeyi etmirsinizsə. Dəqiq bildiyimiz bir şey var ki, zaman keçdikcə yaxşılaşacaq. Amma proses heç vaxt bitməyəcək :-).
Mənbə: www.habr.com