Informacje techniczne według celu
Różne dokumenty odpowiadają na różne praktyczne pytania.
| Forma dokumentu | Cel | Czytaj obok |
|---|---|---|
| Przewodnik techniczny | Wyjaśnia zastosowanie zidentyfikowanych wymagań. | Relewantne źródłowe wymagania i wydanie. |
| Notatka praktyczna | Dotyczy skoncentrowanej metody lub powtarzających się trudności. | Jego zakres, założenia i zamierzeni użytkownicy. |
| Raport techniczny | Przedstawia badanie, metodę lub wyniki. | Dowody i ograniczenia zarejestrowane w raporcie. |
| Biuletyn informacyjny | Podsumowuje temat dla określonej publiczności. | Cytowane źródła podstawowe i data przeglądu. |
Od wymagań do praktyki
Wymagania muszą być stosowane do rzeczywistych produktów, procesów i dowodów. Wskazówki techniczne dotyczą praktycznych pytań, które pojawiają się podczas ich stosowania: wybór podejścia, rejestracja założeń, ocena dowodów i wyjaśnienie wniosku.
Formy wskazówek
Przewodnik techniczny wyjaśnia temat w głębi. Notatka praktyczna dotyczy określonego zadania. Raport techniczny przedstawia badanie lub metodę. Stanowisko określa uzasadniony pogląd na określony problem. Zapis dokumentu identyfikuje, jaki typ dokumentu czytelnik używa.
Podstawa techniczna
Wskazówki identyfikują swoje źródła i odróżniają wymagania od porad wyjaśniających. Odwołania do norm europejskich lub międzynarodowych zachowują status oryginalnych dokumentów. Stosowne wydanie i kontekst, w którym odniesienie jest używane, mają znaczenie dla interpretacji.
Rozwój i przegląd
Pozycja pracy definiuje pytanie, publiczność i oczekiwany wynik. Autorzy przygotowują materiał w ramach tego zakresu. Przegląd techniczny rozważa metodę, dowody, terminologię i ograniczenia przed przejściem dokumentu przez procedurę zatwierdzania.
Znajdowanie dokumentu
W przypadku zapytania o dokument, podaj tytuł lub odniesienie, temat i wydanie, jeśli jest znane. Wyjaśnij zadanie lub fragment dotknięty, aby można było rozważyć istotność materiału.
Wkład w wskazówki
Wkład może rozpocząć się od propozycji pracy, udziału eksperta lub komentarzy do konsultacji. Użyteczny wkład identyfikuje problem techniczny i daje uzasadnioną podstawę dla proponowanego traktowania.
Użycie i pozwolenia
Własne warunki publikacji regulują jej użycie. Pozwolenie na odczytanie przewodnika niekoniecznie obejmuje pozwolenie na jego odtworzenie lub dystrybucję zewnętrznej normy cytowanej w nim. W przypadku ponownego użycia lub tłumaczenia, zidentyfikuj dokument i zamierzone użycie.