Charakterystyka pouczająca, struktura i przykłady

A pouczający Jest to dokument, który ma na celu dostarczenie pewnych informacji, w szczególności, jak coś zrobić. Teksty te służą jako przewodnik dla osoby, która zna właściwy sposób wykonywania czynności lub informowania o czymś.

Większość instrukcji zawiera pisemny przewodnik lub tekst z instrukcjami oraz niektóre powiązane obrazy (takie jak diagramy), które mogą pomóc w zrozumieniu problemu.

Chodzi o to, że instrukcje są pisane w sposób nietechniczny, aby mogły być zrozumiane przez największą liczbę osób.

Poziom terminologii technicznej i poziom treści powinien być inny niż przewodnik dla ekspertów, ponieważ instrukcje powinny być kierowane do wspólnego obywatela.

Z tego powodu ważne jest określenie, do kogo skierowany jest przewodnik; różni czytelnicy będą mieli różne wymagania.

Ponadto instrukcje muszą mieć strukturę, która obejmuje okładkę, wprowadzenie, słowniczek, ogólny opis i instrukcje, między innymi elementami.

Jak sama nazwa wskazuje, instrukcje są tekstami pisanymi, aby pomóc ludziom zrozumieć, jak korzystać z systemu.

Ogólnie instrukcje są niezbędne przy wdrażaniu systemu technologicznego oprogramowanie, złożyć mebel lub instrukcje dotyczące korzystania z urządzenia elektronicznego.

Instrukcje muszą być pierwszym elementem, który należy przeczytać przy nabywaniu nowego produktu.

Czytając instrukcje, możesz rozwiązać wiele wątpliwości, nie wymagając pomocy technicznej ani wsparcia ze strony producenta.

Główne cechy instrukcji

- Zawiera instrukcje krok po kroku dotyczące użytkowania produktu.

- Zawierają absolutnie wszystkie instrukcje produktu we wszystkich możliwych aspektach.

- Zaczynają od szybkiego, jednostronicowego podręcznika użytkownika.

- Mówią użytkownikowi, jakie są funkcje produktu i do czego służą, a nie tylko, jak korzystać z tych funkcji.

- Uwzględniają one potrzeby niepełnosprawnych użytkowników (takich jak słabe widzenie lub ślepota barw) i zapewniają alternatywne instrukcje dla takich użytkowników, takie jak dźwięk, brajl lub większe litery.

- Używają tylko jednego języka.

- Mają efektywne wykorzystanie koloru.

- Twoje strony są numerowane i mają indeks.

- Mają zdjęcia lub diagramy, które pomagają zrozumieć produkt i instrukcje.

- Używają czystego i czytelnego źródła; Oznacza to, że nie używają czcionek z szeryfami.

Struktura

1- Wprowadzenie

Zawiera wszystkie niezbędne informacje, aby użytkownik mógł korzystać z całego systemu lub produktu. Ta część powinna zawierać opis funkcji systemu i jego możliwości, awaryjne i alternatywne tryby działania, procedury krok po kroku i zastosowanie.

Jeśli to możliwe, należy użyć grafiki. Ta sekcja zawiera również opis celu instrukcji, jej organizacji i możliwych odniesień.

2- Punkty kontaktowe

Ta sekcja zawiera kody organizacji i zespołu, które mogą pomóc użytkownikowi. Jeśli jest jakaś pomoc telefoniczna lub helpdesk, jest to opisane w tej sekcji.

3- Podstawowe funkcje biznesowe

Ta sekcja zawiera perspektywę biznesową podstawowych obowiązków użytkownika w odniesieniu do produktu lub systemu.

4- Glosariusz

Oto słowniczek terminów i skrótów używanych w instrukcjach. Jeśli jest bardzo długi, więcej niż kilka stron, jest umieszczony jako dodatek.

5- Możliwości systemu lub produktu

W tej części znajduje się krótkie podsumowanie systemu i możliwości produktu; jego cel musi zostać opisany.

Pomysł polega na zrozumieniu przez użytkownika funkcji i operacji systemu, w tym określonych funkcji wysokiego poziomu. W razie potrzeby należy dołączyć wykresy lub tabele.

6- Opis funkcji

Opisana jest każda konkretna funkcja systemu. Mogą być włączone następujące elementy:

- Cel i wykorzystanie funkcji. Należy również dodać relacje z innymi funkcjami.

- Inicjalizacja funkcji, jeśli dotyczy.

- Opcje wykonania związane z funkcją i jej opisem.

- Opis oczekiwanych nakładów i ich wyników.

7- Przygotowanie funkcji wejściowych

Ta sekcja zawiera dane wejściowe wymagane do poprawnego działania systemu lub produktu.

8- Wyniki

Należy również uwzględnić oczekiwane wyniki każdej funkcji. Wyniki te powinny zawierać grafikę, tekst i tabele, które mogą pomóc użytkownikowi. Dodatkowo zamieszczono również przykłady.

9- Instrukcja obsługi

Oto lista procesów związanych z instrukcją obsługi. Na przykład musi zawierać procedury wejścia do systemu w przypadku jego zastosowania.

Ta procedura inicjalizacji powinna opisywać, jak ustalić wymagany tryb działania i jak zainicjować parametry wymagane do działania.

10- Konserwacja

Ta sekcja zawiera procedury zapewniające prawidłowe działanie systemu lub produktu.

11- Błędy

Ta sekcja musi uwzględniać wszelkie komunikaty o błędach, które mogą pojawić się w systemie lub jakiekolwiek możliwe usterki sprzętu.

Na przykład powinieneś dołączyć listę wszystkich komunikatów o błędach, które mogą się pojawić, co oznaczają i jak je rozwiązać.

Przykłady instrukcji

1- Instrukcja montażu fotela

Bezpieczeństwo

Przeczytaj, zrozum i postępuj zgodnie z instrukcjami bezpieczeństwa dla każdego z nich. Jeśli nie rozumiesz, skontaktuj się z producentem.

Chroń oczy okularami ochronnymi, uszami z izolatorami i płucami przy pomocy respiratora lub maski.

Plan budowy

Wytnij drewnianą deskę 2x4x8, cztery stoły 1x3x1 i trzy stoły 5x3x2.

Złóż stół zgodnie ze schematem i zaznacz ołówkiem punkty łączenia w rogach. Następnie zabezpiecz części paznokciem i młotkiem.

2- Instrukcje Mplus

Mplus to program do modelowania statystycznego, który daje naukowcom elastyczne narzędzie do analizy informacji.

Oferuje użytkownikom różne modele, estymatory i algorytmy w przyjaznym dla użytkownika interfejsie.

Organizacja

Rozdział 2 opisuje, jak rozpocząć korzystanie z Mplus. Od rozdziału 3 do 13 zawierają przykłady analizy, które można wykonać za pomocą programu. Rozdział 14 omawia specjalne problemy.

Rozdział 1

Rysunek na następnej stronie pokazuje różne zależności, które można modelować w Mplus.

Prostokąty reprezentują obserwowane zmienne; zmienne w tle są odzwierciedlone jako x.

Okręgi reprezentują zmienne ukryte, a strzałki na figurach przedstawiają relacje między zmiennymi.

Funkcje specjalne obejmują:

1- Analizy indywidualne lub grupowe.

2 - Stratyfikacja, prawdopodobieństwa selekcji, powielone wagi i korekty populacji skończonej.

3- Maksymalne oszacowanie rodzajów wyników.

Diagrammer

Można go użyć do narysowania diagramu wejściowego. Aby wejść do tej funkcji, musisz otworzyć menu układu w edytorze Mplus. Zestaw narzędzi do rysowania służy do tworzenia diagramu.

Kalkulator LTA

Prawdopodobieństwa warunkowe są obliczane, w tym ukryte prawdopodobieństwa przejścia dla różnych wartości. Można go użyć podczas wybierania Kalkulatora LTA z menu Mplus Edytora Mplus.

Referencje

1. Podręcznik ręczny. Pobrane ze statmodel.com
2. Rookies guide to building furniture (2017). Źródło z sawsonskates.com
3. Wskazówki dotyczące pisania instrukcji obsługi. Pobrane z userfocus.co.uk
4. Podręcznik użytkownika. Źródło z wikipedia.org
5. Samouczek instrukcji obsługi. Odzyskany z klariti.com