Instruktivne karakteristike, struktura i primjeri

poučan To je dokument koji nastoji dati neke informacije o tome kako učiniti nešto posebno. Ovi tekstovi služe kao vodič za pojedinca da zna ispravan način za obavljanje neke radnje ili informiranje o nečemu.

Većina uputa ima pisani vodič ili tekst s uputama, te neke povezane slike (kao što su dijagrami) koje bi mogle pomoći pojedincu da razumije problem.

Ideja je da su upute napisane na netehnički način kako bi ih razumio najveći broj ljudi.

Razina tehničke terminologije i razina sadržaja trebali bi biti različiti od vodiča za stručnjake, jer bi upute trebalo uputiti običnom građaninu.

Zbog toga je važno definirati kome je vodič usmjeren; različiti čitatelji će imati različite zahtjeve.

Osim toga, upute moraju imati strukturu koja uključuje naslovnicu, uvod, pojmovnik, opći opis i upute, među ostalim elementima.

Kao što ime implicira, upute su pisani tekstovi koji pomažu ljudima razumjeti kako koristiti sustav.

Općenito, upute su potrebne pri implementaciji tehnološkog sustava softver, sastavite komad namještaja ili upute o tome kako koristiti elektronički uređaj.

Upute moraju biti prvi element koji se mora pročitati pri stjecanju novog proizvoda.

Čitajući upute možete riješiti mnoge sumnje o tome bez potrebe za tehničkom podrškom ili podrškom proizvođača.

Glavne karakteristike uputa

- Korak-po-korak upute o korištenju proizvoda su uključene.

- Oni sadrže apsolutno sve upute proizvoda, u svim mogućim aspektima.

- Počinju s brzim korisničkim priručnikom na jednoj stranici.

- Oni korisniku kažu koje su funkcije proizvoda i za što služe, a ne samo kako koristiti te funkcije.

- Oni uzimaju u obzir potrebe korisnika s invaliditetom (kao što su slabovidnost ili sljepoća boja) i pružaju alternativne upute za te korisnike, kao što su zvučna, brajeva ili veća slova.

- Koriste samo jedan jezik.

- Oni imaju učinkovitu uporabu boje.

- Vaše su stranice numerirane i imaju indeks.

- Imaju slike ili dijagrame koji pomažu u razumijevanju proizvoda i uputa.

- Koriste čist i čitljiv izvor; to znači da ne koriste fontove sa serifom.

struktura

1. Uvod

Sadrži sve bitne informacije za korisnika za korištenje cijelog sustava ili proizvoda. Ovaj dio treba uključivati ​​opis funkcija sustava i njegovih mogućnosti, nepredviđenih okolnosti i alternativnih načina rada, postupne postupke i upotrebu.

Ako je moguće, treba koristiti grafiku. Ovaj odjeljak daje i opis svrhe uputa, njegovu organizaciju i moguće reference.

2- Kontaktne točke

Ovaj odjeljak identificira kodove organizacije i tima koji mogu pomoći korisniku. Ako postoji telefonska pomoć ili služba za pomoć, to je opisano u ovom odjeljku.

3 - Primarne poslovne funkcije

Ovaj odjeljak uključuje poslovnu perspektivu primarnih odgovornosti korisnika u odnosu na proizvod ili sustav.

4 - Rječnik

Ovdje je rječnik pojmova i kratica korištenih u uputama. Ako je vrlo duga, više od nekoliko stranica, postavlja se kao dodatak.

5 - Sposobnosti sustava ili proizvoda

U ovom se dijelu daje kratak pregled sustava i mogućnosti proizvoda; njegova svrha mora biti opisana.

Ideja je da korisnik razumije funkcije i operacije sustava, uključujući specifične funkcije na visokoj razini. Ako je potrebno, treba uključiti grafikone ili tablice.

6- Opis funkcija

Opisana je svaka specifična funkcija sustava. Može se uključiti sljedeće:

- Svrha i korištenje funkcije. Odnosi s drugim funkcijama također moraju biti dodani.

- Inicijalizacija funkcije, ako je primjenjiva.

- Opcije izvršenja povezane s funkcijom i opisom istih.

- Opis očekivanih inputa i njihovih rezultata.

7- Priprema ulaznih funkcija

Ovaj odjeljak uključuje ulaze potrebne za ispravan rad sustava ili proizvoda.

8. Rezultati

Očekivani rezultati svake funkcije također bi trebali biti uključeni. Ovi rezultati trebaju uključivati ​​grafiku, tekst i tablice koje mogu pomoći korisniku. Osim toga, postavljeni su i primjeri.

9- Upute za uporabu

Slijedi popis postupaka povezanih s uputama za uporabu. Na primjer, mora sadržavati postupke za ulazak u sustav u slučaju da se primjenjuje.

Ovaj postupak inicijalizacije treba opisati kako uspostaviti potreban način rada i kako pokrenuti parametre potrebne za rad.

10. Održavanje

Ovaj odjeljak uključuje postupke za ispravno funkcioniranje sustava ili proizvoda.

11- Pogreške

Ovaj odjeljak mora se pobrinuti za svaku poruku o pogrešci koja bi se mogla pojaviti u sustavu ili eventualni kvar na opremi.

Na primjer, trebali biste uključiti popis svih poruka o pogreškama koje se mogu pojaviti, što oni znače i kako ih riješiti.

Primjeri uputa

1. Upute za montažu stolice

sigurnosti

Pročitajte, shvatite i slijedite sigurnosne upute za svaku od njih. Ako ne razumijete, obratite se proizvođaču.

Zaštitite oči zaštitnim naočalama, ušima s izolatorima i plućima pomoću respiratora ili maske.

Plan izgradnje

Izrežite drvenu ploču od 2x4x8, četiri stola od 1x3x1 i tri stola od 5x3x2.

Sastavite stol prema dijagramu i označite točke povezivanja u kutovima s olovkom. Zatim osigurajte dijelove čavlom i čekićem.

2. Mplus upute

Mplus je program statističkog modeliranja koji istraživačima daje fleksibilan alat za analizu njihovih informacija.

Korisnicima nudi raznovrsne modele, procjenitelje i algoritme u sučelju prilagođenom korisniku.

organizacija

Poglavlje 2 opisuje kako početi koristiti Mplus. Od poglavlja 3 do 13 sadrže primjere analiza koje se mogu obaviti s programom. Poglavlje 14 raspravlja o posebnim problemima.

Poglavlje 1. \ T

Slika na sljedećoj stranici prikazuje različite odnose koji se mogu modelirati u Mplusu.

Pravokutnici predstavljaju promatrane varijable; varijable u pozadini se reflektiraju kao x.

Krugovi predstavljaju latentne varijable, a strelice na slikama predstavljaju odnose između varijabli.

Posebne značajke uključuju:

1. Individualne ili grupne analize.

2 - Stratifikacija, vjerojatnosti odabira, ponovljene težine i korekcije konačne populacije.

3 - Maksimalna procjena za vrste rezultata.

diagramador

Može se koristiti za crtanje ulaznog dijagrama. Da biste pristupili ovoj funkciji, morate otvoriti izbornik izgleda u uređivaču Mplus. Za izradu dijagrama koristi se skup alata za crtanje.

LTA kalkulator

Izračunavaju se uvjetne vjerojatnosti, uključujući latentne vjerojatnosti prijelaza za različite vrijednosti. Može se koristiti pri odabiru LTA kalkulatora iz Mplus izbornika Mplus Editor-a.

reference

1. Ručni vodič. Preuzeto sa statmodel.com
2. Početni vodič za građevinski namještaj (2017.). Preuzeto s sawsonskates.com
3. Savjeti za pisanje korisničkih priručnika. Dobavljeno iz userfocus.co.uk
4. Korisnički priručnik. Preuzeto s wikipedia.org
5. Vodič za korisnike. Oporavio se od klariti.com