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

Anonim

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

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

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

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

Подредете информацията в съответния ред. Схемата включва групиране на информацията в логически раздели и нива. Можете да създавате основни теми и подтеми и под-теми.

Завършете схемата, като прегледате информацията, за да проверите дали темите са организирани по подходящ и логичен начин. Уверете се, че нямате никакви ключови факти. Изтрийте всяка информация, която не е от значение за техническия документ.