Jak napisać notatkę techniczną

Spisu treści:

Anonim

Dokładność i szczegóły to cechy dobrze napisanej notatki technicznej. Żargon przemysłowy to norma. Notatka techniczna kieruje kolejnością operacji i jest używana w pewnym sensie jako plan raportu towarzyszącego, zestawu instrukcji lub zadania laboratoryjnego. W przeciwieństwie do innych notatek, jest dłuższy i może zawierać ilustracje, rysunki, wykresy i legendę.

Zaadresuj notatkę do czytelników, którzy znają lub przynajmniej znają dziedzinę studiów. Używaj szczegółowych informacji w miarę możliwości i unikaj tła lub niepotrzebnego kontekstu. Innymi słowy, pisz zwięźle.

$config[code] not found

Wpisz memo w jednym odstępie, używając marginesów jednego cala w nieobramowanej 12-punktowej standardowej powierzchni. Notatka powinna mieć czytelny, profesjonalny wygląd.

Dołącz wszystkie schematyczne diagramy do treści notatki, ze strzałkami wskazującymi na istotne informacje, oznaczającymi dowolne części. Można to ręcznie narysować lub wyciąć i wkleić za pomocą edytora tekstu.

Ustaw nagłówek każdej sekcji notatki pogrubioną: Wprowadzenie, metoda / analiza, dyskusja i konkluzja.

Dodaj odniesienia na dole notatki technicznej, aby pokazać odbiorcom, gdzie narysowałeś materiał źródłowy. Powinno to brzmieć jak mini-bibliografia.

Dołącz informacje uzupełniające jako załączniki i dostarcz ich kopię do złożenia. Nota techniczna powinna być okładką.

Wskazówka

Dokładnie sprawdź, czy wymagania dotyczące formatu różnią się w zależności od branży.