Charakterystyka raportu technicznego, części, przykłady

A raport techniczny Jest to dokument, którego celem jest opisanie procesu, postępów lub wyników badań technicznych lub naukowych. W niektórych przypadkach może to obejmować wstępne zalecenia i wnioski na temat bieżącego dochodzenia.

W przeciwieństwie do publikacji artykułów naukowych i wyspecjalizowanej literatury, raporty techniczne rzadko przechodzą proces przeglądu przez kolegów lub par przed publikacją. Wynika to z faktu, że proces przeglądu treści jest odpowiedzialny za organizację, która je przygotowuje.

Dziś jest to jedna z najczęściej stosowanych metod do prezentacji informacji technicznych i naukowych w prosty sposób w projekcie badawczym, który musi być promowany ekonomicznie przez sponsorów.

Ponieważ raport techniczny jest skierowany do wyspecjalizowanej publiczności, składającej się z inżynierów, architektów, naukowców lub naukowców, język używany do ich pisania musi przestrzegać określonych standardów, które pozwalają czytelnikowi całkowicie i zwinny.

[TOC]

Charakterystyka raportu technicznego

Raport techniczny można złożyć w formacie fizycznym lub wirtualnym

Główne cechy raportu technicznego to:

Język

Musi być napisane formalnym, zwięzłym i jasnym językiem.

Niezawodność

Prawdziwość i dokładność danych, z którymi działają one.

Struktura

Twoja organizacja i struktura powinny umożliwić łatwe czytanie i zrozumienie jej treści.

Grafika

Przykład wykresu zawartego w raporcie technicznym UNAM (patrz w końcowej sekcji tego artykułu)

Uwzględnij grafikę, obrazy, zdjęcia i tabele, aby wyświetlać dane.

Dokumentacja

Źródła informacji są bardzo ważne w raportach technicznych, zapewniają niezawodność badania.

Selektywność odbiorców

Jest zaprojektowany do odczytania określonego rodzaju odbiorców, zainteresowanych wynikami raportu.

Nagłówki

Tytuły muszą być zlokalizowane w taki sposób, aby czytelnik mógł łatwo zlokalizować informacje z każdej sekcji w tekście.

Prezentacja

Muszą być zbudowane na arkuszu wielkości A4, z marginesami na poziomie 2,54 cm. Wszystkie strony są ponumerowane.

Części raportu technicznego

Strony, które musi zawierać raport techniczny, to następujące.

Może ci służyć: motywacje badacza

Tytuł i okładka

Pokrycie raportu UNAM (patrz Sekcja przykładów)

Tytuł powinien zostać wybrany tak krótki i zwięzły, jak to możliwe, próbując dać ogólne wyobrażenie o tym, co zostanie przedstawione w raporcie.

Tytuł ma zadanie przyciągnięcia uwagi czytelnika, ponieważ konieczne jest rozpoczęcie od ważnego słowa, związane z treścią raportu. Musi to zostać uwzględnione w trzech częściach raportu:

• Na stronie tytułowej, w której umieszczane są również data publikacji i nazwisko autora.
• Na stronie podsumowania.
• Na pierwszej stronie ciała raportu.

Okładka obejmuje tytuł, autorzy raportu, instytucja, która to zrobiła, oraz instytucję, która zleciła jej w razie potrzeby.

Streszczenie

Musi być zawsze ustawiony na początku raportu. Ma na celu możliwych czytelników, dając im krótkie wyobrażenie o tym, co zostanie znalezione w raporcie. Uzyskane wyniki lub wnioski nie są umieszczone. Idealnie nie pokonano 200 słów

Treść lub tabela indeksu

Złożone z nazw sekcji, wraz z ich numerami stron. Jest to narzędzie, które ułatwia czytelnikowi lokalizację problemów, które go interesują. Jest to ogólnie używane, gdy raport jest bardzo długi.

Wstęp

Jest to przedstawienie tematu, który należy opracować. Informacje, które zawiera, zależy od rodzaju przeprowadzonego raportu. Jeśli jest to opracowanie procesu, we wstępie jego działanie jest narażone, przyczyną jego rozwoju i kto skorzysta z jego wdrażania.

W przypadku recenzji we wstępie należy ustalić zakres raportu i komu będzie on skierowany. Mówiąc o eksperymentach, należy wykonać podsumowanie, pokazując, w jaki sposób wykonana praca poprawia lub uzupełnia poprzednie prace. W przypadku badań wprowadzenie raportu technicznego musi wskazywać, jaki będzie zakres tego samego

Ciało raportu

Bez wątpienia jest to najważniejsza część raportu technicznego. Użycie grafiki i tabel ułatwia zrozumienie tego samego.

Może ci służyć: przykłady ram teoretycznych

Oto cele badania, propozycje teoretyczne, metody stosowane do przeprowadzania badań, porównania z innymi raportami oraz wyniki uzyskane w ramach przeprowadzonego procesu.

Wnioski

Wnioski są odpowiedzią na pytania, które pojawiły się w badaniu i muszą być bezpośrednio skierowane do ciała raportu.

Odniesienia i bibliografia

Jest to lista źródeł konsultacji o badaniach, na których opiera się raport. Służy jako odniesienie do czytelników i zapewnia wiarygodność pracy.

Jak złożyć raport techniczny?

Aby złożyć raport techniczny, należy wykonać następujące kroki.

1- Planowanie

Na tym etapie poszukiwane są bibliografia i raporty na temat tego, co chcesz się uczyć, a następnie luźne pomysły lub tematy, które są ważne, a wreszcie raport jest ustrukturyzowany.

2- Projekt konstrukcji

Tutaj zaczynasz pisać, pogłębiając więcej pomysłów zaproponowanych na etapie planowania. Wskazane jest, aby zacząć od treści raportu, po strukturze zaproponowanej w poprzednim kroku.

Nie uważaj na styl używanego języka, ponieważ zostanie to poprawione później. 

Jednocześnie w tym kroku możesz wykonać pod ręką wykresy lub diagramy, aby wprowadzić dane. Następnie piszemy wnioski i wreszcie wprowadzenie. Wszystkie te wstępne i podlegające kolejnym zmianom.

3- Projekt przeglądu

W tym kroku dokonana jest recenzja wszystkiego, co zostało napisane, dając bardziej techniczny język do pracy i zamawiając strony w spójny sposób.

4- Włączenie grafiki i tabel

Tutaj wszystkie dostępne tabele, grafiki i diagramy mają ostateczny format i znajdują się logicznie w raporcie.

5- Ostateczny projekt raportu

W tej fazie dokonano ostatecznego projektu raportu. Zazwyczaj jest używany rozmiar czcionki 12 pT dla tekstu, a rozmiary dla tytułów i napisów można zmienić.

Nie zaleca się stosowania wielu różnych wielkości liter, ponieważ można je pomylić dla czytelnika.

Może ci służyć: jakie są źródła badań?

Lokalizacja 6-nagłówka

Tytuły i napisy są używane jako przewodnik dla czytelników, a także do skrócenia akapitów. Należy je umieścić zgodnie z planowaną sekwencją podczas poprzednich kroków, aby zawsze występuje spójność w prezentacji treści.

7- Włączenie źródeł informacji

Wszystkie skonsultowane źródła muszą być właściwie odwołane.

8- Pisanie podsumowujące

Po ukończeniu wszystkich poprzednich kroków, podsumowanie raportu jest teraz napisane, które nie powinno przekraczać 200 słów.

9- Ostateczna recenzja

Po zakończeniu raportu dokonano pełnego przeglądu w poszukiwaniu błędów. Podobnie, może być zbadany przez inną osobę, zorientowaną na temat poruszonego przez śledztwo, aby zapewnić wyższą jakość raportu.

Przykład raportu technicznego

Poniżej znajduje się przykład technicznego raportu nieakademickiego, wysłanego z warsztatu do działu badań fabryki oleju naftowego.

Warsztaty Manoolito

11 listopada 2008

ROMANS: Raport techniczny na temat testów oleju.

Pan. Jaime Quiroga

Szef badań

Oleje Quiroga s.DO.

Po przeprowadzeniu testów różnych rodzajów olejów w testowanym silniku wygenerowano następujące:

RAPORT TECHNICZNY

Przetestowano następujące oleje:

• Syntetyczny.
• Minerał
• Standardowy
• O wysokim przebiegu.

Uzyskane wyniki dały następujące dane:

Ogrzewanie: Za pomocą olejków syntetycznych i o wysokim przebiegu silnik ma temperaturę 90 ° C, a przy minerałach i konwencjonalnych wynosiła 103 ° C.

Emisja gazu: tylko olej o wysokim przebiegu uzyskał emisję gazów poniżej dozwolonej limitu. Pozostałe osiągnęły emisje, które przekroczyły limit między 20% a 30%.

Wniosek: Na podstawie wyników przeprowadzonych testów uważamy, że olej o wysokim przebiegu jest najlepszy z czterech testowanych.

Inne przykłady

Raport techniczny National Autonomous University of Mexico.

Raport techniczny Ministerstwa Spraw Rolniczych, chłopów i rybołówstwa Boliwii.

Bibliografia

1. DO.L. Moorthy, c. K. (1997). Pisanie raportów technicznych: metody i procedury. Pobrano z DRTC.Isibang.AC.W
2. Batovski, zm. DO. (2010). Jak napisać do raportu technicznego. Pobrano z ResearchGate.internet
3. Joffré Encinas, j. (2020). Przewodnik do pisania raportów technicznych. Pobrano z inżynierii.UASLP.MX
4. McMurrey, zm. DO. (2020). Raporty techniczne. Pobrano z Tu-Chamnitz.z
5. Prance, d. H. (2010). Przewodnik po pisaniu raportów technicznych. Pobrano z Sussex.AC.Wielka Brytania