Jak zarysować techniczne dokumenty do pisania

Anonim

Jak zarysować techniczne dokumenty do pisania. Dobrze napisany dokument nie jest tworzony przez przypadek. Materiały zawarte w raporcie, podręczniku lub innym dokumencie technicznym są planowane, organizowane, a następnie pisane. Etap tworzenia dokumentu jest kluczowym krokiem i istnieje duże prawdopodobieństwo, że informacje nie zostaną przedstawione logicznie, jeśli nie zostanie utworzony zarys. Tworzenie zarysów daje twórcy szansę na zastanowienie się nad informacjami, które powinny i nie powinny być uwzględnione.

Burza mózgów pomysłów. Zapisz wszelkie pomysły w swoim szkicu, które Twoim zdaniem powinny znaleźć się w dokumencie technicznym. Nie przejmuj się kolejnością informacji. Ważne jest, aby wszystkie informacje zostały uwzględnione w procesie burzy mózgów.

Określić cel dokumentu technicznego. Zadaj sobie pytania, na przykład, kto będzie czytał dokument, dlaczego będzie czytany i jak będzie używany.

Zdecyduj, jaki typ konturu chcesz utworzyć: historyczny, chronologiczny, specyficzny dla ogólnych, małych i dużych, prostych do złożonych lub dowolnych innych form odpowiednich do treści. Zastanów się nad publicznością i informacjami, które chcesz zaprezentować. Upewnij się, że sposób uporządkowania informacji ma największy sens dla rodzaju prezentowanych informacji i dla odbiorców, którzy będą czytać dokument techniczny.

Ułóż informacje we właściwej kolejności. Zarys obejmuje grupowanie informacji w logiczne sekcje i poziomy. Możesz tworzyć główne tematy i podtematy oraz pod-podtematy.

Zakończ zarys, przeglądając informacje, aby sprawdzić, czy przedmioty są odpowiednio zorganizowane i logiczne. Upewnij się, że nie brakuje ci żadnych kluczowych faktów. Usuń wszelkie informacje, które nie są związane z dokumentem technicznym.