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

Anonim

Писање техничког приручника је једноставан задатак који укључује организовање корака и стварање јасних, концизних формулација. Циљ техничког приручника је да пружи информације о томе како извршити операцију у најмањој могућој мјери и на најјаснији могући начин. Технички приручници често укључују сарадњу многих људи, укључујући стручњаке за предмет, уреднике и техничке писце. Пошто технички приручници могу бити подвргнути сталној ревизији и ажурирању, комуникација између укључених страна је кључна за развој приручника.

Одредите стил техничког приручника или креирањем поједностављеног водича за стил или праћењем постојећег водича за стил, као што је Мицрософт Стиле Гуиде за техничке приручнике. Стилски водич ће помоћи у креирању скелета приручника и осигурати досљедност.

Напишите кораке за процедуру почевши од глагола. Ако су потребне консултације за писање корака, интервју и постављање питања стручњака за предмет. Ово ће осигурати валидност процедура; у супротном, кораци не морају бити логични и / или неисправни. Кораци треба да буду логички уређени и подељени у логичка поглавља или поделе.

Додајте графике и илустрације корацима који их захтевају. Не заборавите додати нумерацију бројева и наслове свакој слици / илустрацији.

Направите садржај и индекс за једноставну референцу.

Додајте дневник промена или лист за ажурирање који бележи сваку промену и ажурирајте приручник за будуће ревизије и издања. Техничке приручнике увијек треба уредити нетко други, а не технички писац, по могућности професионални уредник.