Техничка документација Повеќе од прирачник ›Списание за пишување мрежи - од издаваштво
Постојат многу чекори вклучени во воведувањето на нов производ. Производот мора внимателно да се испланира и внимателно да се испита секој чекор за развој. Кога производот е завршен и подготвен за лансирање на пазарот, инвеститорот треба да осигури дека тој внимателно ја комплетира техничката документација на производот. Законодавците бараат детална техничка документација за да се осигури безбедноста и правилното работење на производот. Со техничката документација вие не само што му помагате на корисникот на производот, туку и ја заштитувате вашата компанија од можни правни напади. Ова го намалува ризикот од одговорност и ги избегнува лутите клиенти, кои во денешно време сакаат да го истураат својот гнев на социјалните мрежи.
Внатрешна и надворешна техничка документација
Надворешната техничка документација е наменета за клиентот или за корисникот на производот. Ова е да се осигура дека корисникот правилно го стартува производот и дека прво може да ја прочита документацијата во случај на какви било проблеми. Како по правило, техничката документација за клиентот е напишана од специјални уредници. Доколку производот се продава на меѓународни пазари, текстовите мора да бидат преведени професионално на соодветните јазици на одделните земји. На пример, во Европа овие се англиски, шпански, полски и шведски. Надворешната техничка документација е попозната како упатства за употреба, упатства за употреба или упатства за употреба, во зависност од производот и целната група.
Професионалната работа вклучена во креирање на документација е особено важна. И покрај користениот технички јазик, корисникот треба да има малку проблеми со разбирањето на упатствата за работа. Покрај разбирливоста на текстовите, секако мора да се почитуваат стилот и граматичките правила. Покрај стандардната документација на хартија што е приложена со секој производ, има смисла да се обезбедат верзии преку Интернет за клиентот. Ова му заштедува на корисникот долго пребарување ако се изгубени оригиналните упатства. Работата со професионален систем за управување со содржини за креирање на документацијата има многу предности. Уредниците се совршено обучени за пишување такви текстови и се сигурни во стилот на пишување. Вие препознавате важни информации и можете ефикасно да ги сумирате како документ. Употребата на надворешни писари заштедува време и пари. Понатаму, можете да бидете сигурни дека документацијата е имплементирана во согласност со сите вообичаени упатства и спецификации.
дискусија
Претплатете се на коментари (RSS)
2 коментари на „Техничка документација: Повеќе од упатство за употреба“.
За мене како единствен развивач (софтвер), досадното создавање документација е исто така начин за гледање на мојата програма (уште еднаш) од перспектива на идниот корисник.
Колку што е можно, знаењето од фазата на создавање документација треба да може да се влева во производот; затоа што честопати препознавате само кога сакате или треба да му го објасните производот на службеникот каде е проблемот и што може да се реши на премногу комплициран начин.
Затоа, на поголемите компании им е потребна опција за повратни информации од писателот на инструкции до развивачите.
Или, треба да го вклучите гледиштето на авторот што е можно порано во процесот на развој.
Јас неодамна доживеав вистински мега-флоп со недостаток на документација: Купив одличен испарувач/резервоар за моите е-пареи, но не беше опишано како се регулира одливот и приливот на течност. Го испратив делот назад затоа што го најдов „заклучен“ на врвот - иако треба да биде Топфилер! Потоа го вратив делот и ете: каде сè беше затворено, одеднаш видов дупки ... сè во ред?
Во никој случај! Дупките за полнење повторно исчезнаа следниот пат кога ќе се обидам ... Накратко: ми требаше долго време да се качам на патеката. Делот имаше навистина генијална механика за отворање и затворање на тие дупки на прилив. За жал, не се самообјаснува и не е документирано!
Резултат: производот во моментов се распродава ... сигурно, никој не може да се справи со тоа без никакви проблеми ...