Podstawy do pisania raportu technicznego

Spisu treści:

Anonim

Jeśli kiedykolwiek przeczytałeś instrukcję montażu lub obsługi nowego zakupu i odszedł bardziej zdezorientowany niż kiedy zacząłeś, nie jesteś sam. Pisanie techniczne może być trudne nawet dla najbardziej doświadczonych profesjonalistów. Jednak pisząc raport techniczny, ważne jest, aby uwzględnić stosowny temat, jasno i zwięźle oraz uporządkować informacje, aby czytelnik mógł z łatwością je zrozumieć.

Wybór przedmiotu

Ludzie zazwyczaj piszą raporty techniczne, kiedy przeprowadzili jakieś badania i muszą przedstawić wyniki konkretnym odbiorcom. Mogą to być badania terenowe - ankiety, wywiady i obserwacje - lub badania książkowe. Bez względu na rodzaj przeprowadzonych badań, nie będziesz w stanie udostępnić wszystkich zebranych informacji. W "Poradniku na temat pisania raportu technicznego" Alan Sherman z University of Maryland w hrabstwie Baltimore sugeruje, że raport powinien skupić się na znaczących odkryciach, które pokazują, że temat waszych badań jest interesujący i ważny. Powinieneś również uwzględnić elementy, takie jak projekt badań i zalecenia, jeśli są one niezbędne.

Być jasne i zwięzłe

Ludzie nie czytają technicznych raportów o kwiecistym języku lub obrazach. Zamiast tego ludzie czytają raporty techniczne, ponieważ szukają konkretnego rodzaju informacji. Bądź jasny i zwięzły podczas pisania raportu. Pomyśl o swoich odbiorcach i celu oraz pisz w sposób, który najlepiej pozwoli czytelnikom zrozumieć, co próbujesz przekazać. Na przykład, jeśli wiesz, że wiele osób mówiących po angielsku jako drugim języku przeczyta twój raport, unikaj klisz i idiomów. O ile to możliwe, bądź na temat, wycinaj słowa, zdania i akapity, których nie potrzebujesz, by zgłosić zebrane informacje.

Organizowanie informacji

Organizacja jest krytyczna w raportach technicznych. Niezależnie od tego, czy piszesz artykuł instruktażowy, czy raport fiskalny w miejscu pracy, niezorganizowane informacje mogą utrudnić czytelnikom korzystanie z tych informacji. Widownia i cel mają duży wpływ na sposób organizacji raportu. To, co Twoi odbiorcy już wiedzą o temacie, określi, czy musisz podać informacje dodatkowe przed konkretami. Jeśli celem raportu jest uzasadnienie wykorzystania pieniędzy lub rzecznika do podjęcia działań, zakończ propozycję lub odwołanie i organizuj treść raportu wokół wsparcia dla tego działania. Osoby piszące instrukcje typu muszą mieć pewność, że kroki są umieszczane we właściwej, chronologicznej kolejności.

Cytowanie zewnętrznych źródeł

Ponieważ informacyjne raporty techniczne często ujawniają wyniki badań, możesz cytować pomysły innych osób w swoich tekstach. Niezależnie od tego, czy cytujesz lub parafrazujesz te źródła, musisz przyznać im kredyt, cytując je. Jeśli piszesz swój raport do pracy, do tego cytatu możesz polecić stopkę lub przypis końcowy. Jeśli jednak piszesz raport do szkoły, Twój nauczyciel lub profesor zazwyczaj wymaga użycia istniejącego stylu cytowania, takiego jak Modern Language Association lub American Psychological Association.