Како описати техничке документе за писање

Anonim

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

Размислите о својим идејама. Запишите било које идеје у свом нацрту за које мислите да би требале бити укључене у технички документ. Не брините о редоследу информација. Само је важно да све информације буду укључене у процес браинсторминга.

Одредите сврху техничког документа. Поставите себи питања попут тога ко ће читати документ, зашто ће се прочитати и како ће се користити.

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

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

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