Програм хангамжийн баримт бичиг нь зөвхөн нийтлэлийн багц юм. Гэхдээ тэд ч гэсэн чамайг галзууруулж чадна. Нэгдүгээрт, та шаардлагатай зааврыг хайж олоход удаан хугацаа зарцуулдаг. Дараа нь та ойлгомжгүй текстийг ойлгодог. Та бичсэн шигээ хийдэг ч асуудал шийдэгдээгүй байна. Өөр нийтлэл хайгаад л, сандраад л... Цагийн дараа бүх зүйлээ орхиод явчихна. Муу баримт бичиг ингэж ажилладаг. Үүнийг юу болгодог, яаж засах вэ - зүслэгийн доор уншина уу.
Манай хуучин бичиг баримтад дутагдал их байсан. Дээр дурдсан хувилбар манай үйлчлүүлэгчдэд нөлөөлөхгүйн тулд бид үүнийг бараг нэг жилийн турш дахин боловсруулж байна. Хараач, и .
Асуудал 1: Тодорхой бус, муу бичсэн нийтлэлүүд
Хэрэв баримт бичгийг ойлгох боломжгүй бол энэ нь ямар учиртай вэ? Гэхдээ хэн ч зориуд ойлгомжгүй нийтлэл бичдэггүй. Зохиогч үзэгчид, зорилгынхоо талаар боддоггүй, ус асгаж, текстийг алдаатай эсэхийг шалгадаггүй тохиолдолд эдгээр нь тохиолддог.
- Лекцийн танхим. Нийтлэл бичихээсээ өмнө уншигчийн бэлтгэлийн түвшинг бодох хэрэгтэй. Эхлэгчдэд зориулсан нийтлэлд та үндсэн алхмуудыг алгасаж, техникийн нэр томъёог тайлбаргүйгээр орхиж болохгүй, гэхдээ зөвхөн мэргэжлийн хүмүүст хэрэгтэй ховор шинж чанарын тухай нийтлэлд PHP гэдэг үгийн утгыг тайлбарлах нь логик юм.
- Зорилго. Бас нэг зүйлийг урьдчилан бодох хэрэгтэй. Зохиогч тодорхой зорилго тавьж, нийтлэлийн ашигтай үр нөлөөг тодорхойлж, уншсаны дараа уншигч юу хийхээ шийдэх ёстой. Хэрэв энэ нь хийгдээгүй бол та тайлбарлахын тулд тайлбартай болно.
- Ус ба хорхой. Маш олон шаардлагагүй мэдээлэл, хүнд суртал, алдаа, үсгийн алдаа нь ойлголтод саад учруулдаг. Уншигч нь дүрмийн нацист биш ч гэсэн текст дэх хайхрамжгүй байдал нь түүнийг унтрааж болно.
Дээрх зөвлөмжийг анхаарч үзээрэй, нийтлэлүүд илүү тодорхой болно - баталгаатай. Үүнийг илүү сайн болгохын тулд манайхыг ашиглана уу .
Бодлого 2. Нийтлэлүүд бүх асуултанд хариулдаггүй
Баримт бичиг нь хөгжлийг гүйцэхгүй, бодит асуултуудад хариулахгүй, алдааг олон жилийн турш засдаггүй бол энэ нь муу юм. Эдгээр нь зохиогчийн асуудал биш, харин компани доторх үйл явцыг зохион байгуулахтай холбоотой асуудал юм.
Баримт бичиг нь хөгжлийг гүйцэхгүй
Энэ функц нь аль хэдийн гарсан бөгөөд маркетинг үүнийг хамрахаар төлөвлөж байгаа бөгөөд дараа нь шинэ нийтлэл эсвэл орчуулга нь баримт бичигт ороогүй байна. Үүнээс болоод бид гаргахаа хойшлуулахаас ч аргагүй болсон. Та хүссэн үедээ техникийн зохиолчдод даалгавраа хүлээлгэж өгөхийг хүн бүрээс хүсч болно, гэхдээ энэ нь ажиллахгүй. Хэрэв процесс автоматжаагүй бол нөхцөл байдал дахин давтагдах болно.
Бид YouTrack-д өөрчлөлт орууллаа. Шинэ функцийн талаар нийтлэл бичих даалгавар нь тухайн шинж чанарыг туршиж эхлэх тэр мөчид техникийн зохиолчид унадаг. Дараа нь сурталчилгааны ажилд бэлтгэхийн тулд маркетинг энэ талаар суралцдаг. Мэдэгдлүүд нь Mattermost корпорацийн мессенжерт ирдэг тул хөгжүүлэгчдийн мэдээг алдах нь ердөө боломжгүй юм.
Баримт бичиг нь хэрэглэгчийн хүсэлтийг тусгаагүй болно
Бид ингэж ажиллаж дассан: нэг онцлог шинж чанар гарч ирэв, бид энэ талаар ярилцсан. Үүнийг хэрхэн асаах, унтраах, нарийн тохируулга хийх талаар бид тайлбарласан. Харин үйлчлүүлэгч манай программ хангамжийг бидний төсөөлөөгүй байдлаар ашиглавал яах вэ? Эсвэл бидний бодож байгаагүй алдаанууд байна уу?
Баримт бичгийг аль болох бүрэн гүйцэд байлгахын тулд бид дэмжлэг үзүүлэх хүсэлт, сэдэвчилсэн форум дээрх асуултууд, хайлтын систем дэх асуулгад дүн шинжилгээ хийхийг зөвлөж байна. Хамгийн алдартай сэдвүүдийг техникийн зохиолчдод шилжүүлэх бөгөөд ингэснээр тэд одоо байгаа нийтлэлүүдийг нэмж эсвэл шинээр бичих боломжтой болно.
Баримт бичгийг сайжруулахгүй байна
Үүнийг шууд төгс хийхэд хэцүү, алдаа гарсаар байх болно. Та үйлчлүүлэгчдийнхээ санал хүсэлтийг хүлээж болно, гэхдээ тэд үсгийн алдаа, алдаа, ойлгомжгүй эсвэл үндэслэлгүй нийтлэл бүрийг мэдээлэх магадлал багатай юм. Үйлчлүүлэгчдээс гадна ажилтнууд баримт бичгийг уншдаг бөгөөд энэ нь тэд ижил алдааг хардаг гэсэн үг юм. Үүнийг ашиглаж болно! Асуудлыг мэдээлэхэд хялбар байх нөхцлийг бүрдүүлэх хэрэгтэй.
Манай дотоод портал дээр ажилтнууд бичиг баримтын талаар санал, санал, санаагаа үлдээдэг бүлэг бий. Дэмжлэгт нийтлэл хэрэгтэй байна, гэхдээ энэ нь байхгүй байна уу? Шалгагч алдааг анзаарсан уу? Түнш алдааны талаар хөгжлийн менежерүүдэд гомдол гаргасан уу? Энэ бүлэгт бүгдээрээ! Техникийн зохиолчид зарим зүйлийг нэн даруй засч, зарим зүйлийг YouTrack руу шилжүүлж, бусдад бодох цаг өгдөг. Сэдвийг мөхөхөөс урьдчилан сэргийлэхийн тулд бид үе үе бүлэг байгаа эсэх, санал хүсэлтийн ач холбогдлыг сануулж байна.
Асуудал 3. Зөв нийтлэлийг олоход удаан хугацаа шаардагдана.
Олдохгүй нийтлэл олдохгүй нийтлэлээс дээрдэх юм алга. Сайн баримт бичгийн уриа нь "Хайлт хийхэд хялбар, олоход хялбар" байх ёстой. Үүнд хэрхэн хүрэх вэ?
Бүтэц зохион байгуулж, сэдвийг сонгох зарчмыг тодорхойлох. Уншигчид "Би энэ нийтлэлийг хаанаас олж болох вэ" гэж бодохгүйн тулд бүтэц нь аль болох ил тод байх ёстой. Дүгнэж хэлэхэд интерфэйс болон даалгавар гэсэн хоёр арга байдаг.
- Интерфэйсээс. Агуулга нь самбарын хэсгүүдийг хуулбарладаг. Хуучин ISPsystem баримт бичигт ийм тохиолдол байсан.
- Даалгавруудаас. Нийтлэл, хэсгүүдийн гарчиг нь хэрэглэгчдийн даалгаврыг тусгасан болно; Гарчиг нь бараг үргэлж үйл үг, "яаж" гэсэн асуултын хариултыг агуулдаг. Одоо бид энэ формат руу шилжиж байна.
Ямар ч арга барилыг сонгохоос үл хамааран тухайн сэдэв нь хэрэглэгчдийн хайж буй зүйлд хамааралтай, хэрэглэгчийн асуултад тусгайлан зориулсан байдлаар тусгагдсан эсэхийг шалгаарай.
Төвлөрсөн хайлтыг тохируулна уу. Тохиромжтой ертөнцөд та үг үсгийн алдаа эсвэл хэлээр алдаа гаргасан ч хайлт ажиллах ёстой. Confluence дахь бидний эрэл хайгуул үүн дээр биднийг баярлуулж чадахгүй байна. Хэрэв танд олон бүтээгдэхүүн байгаа бөгөөд баримт бичиг нь ерөнхий бол хайлтыг хэрэглэгчийн байгаа хуудсанд тохируулна уу. Манай тохиолдолд үндсэн хуудсан дээрх хайлт нь бүх бүтээгдэхүүнд зориулагдсан бөгөөд хэрэв та аль хэдийн тодорхой хэсэгт байгаа бол зөвхөн түүн дэх нийтлэлүүдэд зориулагдсан болно.
Агуулга болон талхны үйрмэг нэмнэ үү. Хуудас бүр нь цэс, талхны үйрмэгтэй байх нь сайн хэрэг - хэрэглэгчийн одоогийн хуудас руу очих зам, ямар ч түвшинд буцаж очих боломжтой. Хуучин ISPsystem баримт бичигт та агуулга руу орохын тулд нийтлэлээс гарах шаардлагатай байсан. Энэ нь тохиромжгүй байсан тул бид үүнийг шинэ зүйлээр зассан.
Бүтээгдэхүүн дэх холбоосыг байрлуул. Хэрэв хүмүүс ижил асуултаар дахин дахин дэмжлэг үзүүлэхээр ирдэг бол интерфэйс дээр түүний шийдлийн талаархи зөвлөмжийг нэмэх нь зүйтэй юм. Хэрэв танд ямар нэгэн мэдээлэл, мэдээлэл байгаа бол хэрэглэгчдэд ямар нэгэн асуудал тулгарсан бол шуудангийн жагсаалтаар мэдэгдэх боломжтой. Тэдэнд санаа зовниж, дэмжлэг үзүүлэх ачааг авч хая.
Гарч ирэх цонхны баруун талд ISPmanager-ийн домайн удирдлагын хэсэгт DNSSEC-ийг тохируулах тухай нийтлэлийн холбоос байна.
Баримт бичгийн хүрээнд хөндлөн лавлагааг тохируулах. Өөр хоорондоо холбоотой нийтлэлүүдийг "холбох" ёстой. Хэрэв нийтлэлүүд дараалсан байвал текст бүрийн төгсгөлд урагш болон хойш чиглэсэн сум оруулахаа мартуузай.
Хүн эхлээд асуултынхаа хариултыг танд биш, харин хайлтын системээс хайж олох магадлалтай. Техникийн шалтгаанаар тэнд бичиг баримтын холбоос байхгүй бол ичмээр юм. Тиймээс хайлтын системийн оновчлолыг анхаарч үзээрэй.
Асуудал 4. Хуучирсан зохион байгуулалт нь ойлголтод саад учруулдаг
Муу текстээс гадна баримт бичгийг дизайнаар эвдэж болно. Хүмүүс сайн бичсэн материалыг уншиж дассан. Блог, нийгмийн сүлжээ, хэвлэл мэдээллийн хэрэгсэл - бүх агуулгыг зөвхөн үзэсгэлэнтэй төдийгүй уншихад хялбар, нүдэнд тааламжтай байдлаар харуулсан. Тиймээс та доорх дэлгэцийн агшин дээрх шиг текстийг хардаг хүний өвдөлтийг хялбархан ойлгож чадна.
Энэ нийтлэлд маш олон дэлгэцийн агшин, онцлох зүйл байгаа бөгөөд тэдгээр нь тус болохгүй, гэхдээ зөвхөн ойлголтод саад учруулдаг (зураг дээр дарж болно)
Та олон тооны эффект бүхий баримт бичгүүдийг удаан унших ёсгүй, гэхдээ та үндсэн дүрмийг анхаарч үзэх хэрэгтэй.
Зохион байгуулалт. Үндсэн текстийн өргөн, фонт, хэмжээ, гарчиг, дэвсгэрийг тодорхойлно. Загвар зохион бүтээгч хөлсөлж, уг ажлыг хүлээн авах эсвэл өөрөө хийх бол Артём Горбуновын "Типографи ба зохион байгуулалт" номыг уншина уу. Энэ нь бүдүүвчийн зөвхөн нэг үзэмжийг харуулсан боловч энэ нь хангалттай юм.
Хуваарилалт. Текстэд юуг онцлон тэмдэглэх шаардлагатайг тодорхойл. Ихэвчлэн энэ нь интерфэйс, товчлуурууд, кодын оруулга, тохиргооны файлууд, "Анхаарна уу" блокуудын зам юм. Эдгээр элементүүдийн хуваарилалт ямар байхыг тодорхойлж, тэдгээрийг журамд тэмдэглэнэ. Цутгах нь бага байх тусмаа сайн гэдгийг санаарай. Тэд олон байхад текст нь чимээ шуугиантай байдаг. Хашилт ч гэсэн хэтэрхий олон удаа ашиглавал чимээ шуугиан үүсгэдэг.
Дэлгэцийн зураг. Ямар тохиолдолд дэлгэцийн агшин шаардлагатай болохыг багтай тохиролц. Алхам бүрийг дүрслэн харуулах шаардлагагүй нь гарцаагүй. Олон тооны дэлгэцийн агшин, үүнд. тусдаа товчлуурууд, ойлголтод саад учруулж, зохион байгуулалтыг сүйтгэдэг. Дэлгэцийн агшин дээрх онцлох зүйл, гарын үсгийн хэмжээ, хэлбэрийг тодорхойлж, журамд тэмдэглэнэ үү. Дүрслэл нь бичсэн зүйлтэй үргэлж нийцэж, хамааралтай байх ёстой гэдгийг санаарай. Дахин хэлэхэд, хэрэв бүтээгдэхүүн байнга шинэчлэгдэж байвал хүн бүрийг хянах нь хэцүү байх болно.
Текстийн урт. Хэт урт нийтлэлээс зайлсхий. Тэдгээрийг хэсэг болгон хувааж, боломжгүй бол нийтлэлийн эхэнд зангуу холбоос бүхий агуулгыг нэмнэ үү. Өгүүллийг богиносгох энгийн арга бол нарийн хүрээний уншигчдад шаардлагатай техникийн мэдээллийг спойлер дор нуух явдал юм.
Форматууд. Нийтлэлдээ хэд хэдэн форматыг нэгтгэнэ үү: текст, видео, зураг. Энэ нь ойлголтыг сайжруулах болно.
Сайхан зохион байгуулалтаар асуудлыг далдлах гэж бүү оролд. Үнэнийг хэлэхэд, бид "боодол" нь хуучирсан баримт бичгийг хадгална гэж найдаж байсан - энэ нь бүтсэнгүй. Текстүүд нь маш их харааны чимээ шуугиан, шаардлагагүй нарийн ширийн зүйлийг агуулсан байсан тул дүрэм журам, шинэ загвар нь хүчгүй байв.
Дээр дурдсан зүйлсийн ихэнхийг таны баримт бичигт ашигладаг платформоор тодорхойлно. Жишээлбэл, бидэнд Confluence байдаг. Би ч бас түүнтэй харьцах хэрэгтэй болсон. Хэрэв сонирхож байвал манай вэб хөгжүүлэгчийн түүхийг уншина уу: .
Хаанаас сайжруулж, яаж амьдрах вэ
Хэрэв таны баримт бичиг ISPsystem шиг өргөн хүрээтэй бөгөөд хаанаас эхлэхээ мэдэхгүй байгаа бол хамгийн том асуудлаас эхэл. Үйлчлүүлэгчид баримт бичгийг ойлгохгүй байна - текстийг сайжруулах, журам гаргах, зохиолчдыг сургах. Баримт бичиг хуучирсан - дотоод үйл явцыг анхаарч үзээрэй. Хамгийн алдартай бүтээгдэхүүний талаархи хамгийн алдартай нийтлэлээс эхлээрэй: дэмжлэг авах, хайлтын систем дэх сайтын аналитик болон асуулгад хандах.
Шууд хэлье - энэ нь амаргүй байх болно. Мөн энэ нь хурдан ажиллах магадлал багатай юм. Дөнгөж эхэлж, зөв зүйл хийхгүй л бол. Бидний баттай мэдэж байгаа нэг зүйл бол цаг хугацаа өнгөрөх тусам сайжирна. Гэхдээ процесс хэзээ ч дуусахгүй :-).
Эх сурвалж: www.habr.com