Как се прилага техническата документация

от ClickHelp - инструмент за създаване на професионална помощ

Почти всеки продукт има някаква документация, която да върви с него. Това може да е просто предупреждение или кратки инструкции за употреба. И все пак, дори тогава, трябва да има човек, разпределен да напише тези два реда и, което е по-важно, да реши какво дори трябва да бъде написано. За по-сложните продукти обаче трябва да има солидно ръководство за потребителя. В противен случай вашата подкрепа ще се раздуе с гневни обаждания и съобщения от недоволни клиенти. Но как всъщност да внедрите техническата документация от нулата? В тази статия ще ви дадем общата представа за процеса на внедряване на документацията.

хора

Ако нямате технически писатели на персонала, можете да направите два начина за това - да наемете специалисти на пълен работен ден или да сключите договор с някого за работа на непълно работно време. Зависи от натовареността, наистина. За някои компании има по-голям смисъл да имат изпълнител на непълно работно време, който да върши работата.

Ако вашият проект за техническа документация ще бъде доста голям и изисква постоянна актуализация и поддръжка, тогава наистина трябва да помислите дали да разполагате със собствен екип за документация. Разбира се, този подход изисква много време и ресурси, но в края на деня ще имате екип от професионалисти, които познават вашия продукт като гърба на ръката им.

процес

На тази стъпка ще трябва основно да се омъжите за своите технически и документационни процеси по отношение на планирането, сроковете и резултатите. От този момент техническите писатели трябва да бъдат поканени на всички дискусии за планиране и технически срещи, тъй като документацията трябва да бъде актуална. С всяка нова версия на продукта трябва да има и издание от екипа по документация. Поддържането на актуализирана документация може да бъде от полза, що се отнася до отклонението на случаите и до това колко успешни са вашите клиенти с продукта.

формат

Форматът на ръководството за потребителя зависи от индустрията, в която се намирате. Техническата документация може да бъде доставена заедно с вашия продукт като печатно ръководство за употреба или на компактдиск. Ако е възможно, помислете за формата на онлайн документация. В наши дни повечето компании са направили своя формат на избор. И за това има много причини. Първото и най-важното - такава документация е лесно за търсене в Google. Всички ваши потребители ще се нуждаят от браузър и интернет връзка, за да получат отговорите.

Уеб базирани решения могат да предложат много. Когато стартирате вашия портал за онлайн документация, вашият маркетинг екип незабавно ще усети ползите от допълнителното излагане в мрежата. Можете да превърнете онлайн ръководството си за потребители в мощен маркетингов инструмент чрез брандиране, ключови думи и търсене.

Ако искате да научите повече за предимствата на публикуването на вашата документация онлайн, вижте тази публикация, наречена „18 милиарда причини“.

Инструменти

Веднага след като разберете документационния формат и сглобите екипа, е време да потърсите подходящите инструменти.

За щастие има много готови решения навън, HAT, или HAT, или помощни инструменти за създаване. Това са специални инструменти, разработени за технически писатели, и те са много повече от софтуер за редактиране на текст. Повечето съвременни решения за технически писатели са много гъвкави, което означава, че ще можете да приспособите инструмента към вашите специфични нужди.

Помощните инструменти за създаване като ClickHelp включват функции за организиране на работния процес по начина, по който работи за вас. Например на потребителите могат да се задават различни роли, има известия по имейл, състояния на теми, функционалност на процеса на преглед и други. Така че можете да коригирате инструмента или да изградите изцяло нов работен процес около функционалността, която вашето помощно авторско решение може да предложи.

заключение

Така се реализира техническата документация като цяло. Разбира се, целият този процес е много по-сложен в действителност. В тази статия сме обхванали само някои елементи от високо ниво на изпълнение на ръководството за потребителя. Надяваме се, че тази публикация ще ви помогне да видите цялата картина и от там ще можете да преминете към по-сериозни задълбочени неща и да постигнете успех в организирането и приемането на процеси за създаване на помощ във вашата компания.

Успех с кариерата ви за технически писания!
ClickHelp екип
Автор, хост и доставяне на документация на платформи и устройства

Първоначално публикуван в clickhelp.co.