Техническа документация: Повече от ръководство за употреба

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

Вътрешна и външна техническа документация

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

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

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

дискусия

Абонирайте се за коментари (RSS)
2 коментара за "Техническа документация: Повече от ръководство за употреба".

За мен като единствен разработчик (софтуер) досадното създаване на документация също е начин за разглеждане на моята програма (още веднъж) от гледна точка на бъдещия потребител.

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

Следователно по-големите компании се нуждаят от възможност за обратна връзка от писателя на инструкции до разработчиците.
Или трябва да включите гледната точка на автора възможно най-рано в процеса на разработка.

Едва наскоро преживях истински мегафлоп с липса на документация: Купих страхотен изпарител/резервоар за моите електронни изпарения, но не беше описано как се регулира изтичането и притока на течност. Изпратих частта обратно, защото я намерих „заключена“ отгоре - въпреки че би трябвало да е Topfiller! След това получих частта обратно и ето: там, където всичко беше затворено, изведнъж видях дупки ... всичко ок?
В никакъв случай! Дупките за пълнене отново изчезнаха при следващия опит ... Накратко: отне ми много време да се кача на пистата. Частта имаше наистина гениална механика за отваряне и затваряне на тези входящи дупки. За съжаление не се обяснява само по себе си и НЕ Е ДОКУМЕНТИРАН!
Резултат: продуктът в момента се продава . разбира се, никой не може да се справи с него без никакви проблеми ...