Käyttöopas
Kokeneet kirjoittajat eivät ole vielä tarkistaneet sivun nykyistä versiota, ja se voi poiketa merkittävästi 10. elokuuta 2019 tarkistetusta
versiosta . vahvistus vaatii
1 muokkauksen .
Käyttöopas on asiakirja, jonka tarkoituksena on auttaa ihmisiä käyttämään järjestelmää. Asiakirja on osa järjestelmän teknistä dokumentaatiota ja sen laatii yleensä tekninen kirjoittaja .
Useimmat käyttöohjeet sisältävät kuvia tekstillisten kuvausten lisäksi. Ohjelmiston tapauksessa kuvakaappaukset sisältyvät yleensä käsikirjaan ja yksinkertaiset ja ymmärrettävät piirustukset laitteiston kuvaukseen. Käytetään kohdeyleisön saatavilla olevaa tyyliä ja kieltä, ammattikieltä pidetään minimissä tai selitetään yksityiskohtaisesti.
Sisältö
Tyypillinen käyttöohje sisältää:
- Huomautus, joka antaa yhteenvedon asiakirjan sisällöstä ja sen tarkoituksesta
- Johdanto, jossa on linkkejä aiheeseen liittyviin asiakirjoihin ja tietoa tämän oppaan parhaasta käytöstä
- Sisältö Sivu
- Luvut, joissa kerrotaan, kuinka käyttää ainakin järjestelmän tärkeimpiä ominaisuuksia
- Luku, jossa kuvataan mahdollisia ongelmia ja ratkaisuja
- Usein kysytyt kysymykset ja vastaukset
- Mistä muualta löytää tietoa aiheesta, yhteystiedot
- Sanasto ja suuremmissa asiakirjoissa hakemisto
Kaikki luvut ja kappaleet sekä kuvat ja taulukot on yleensä numeroitu niin, että niihin voidaan viitata asiakirjassa tai toisesta asiakirjasta. Numerointi helpottaa myös ohjeen osiin linkittämistä esimerkiksi silloin, kun käyttäjä kommunikoi tukitiimin kanssa.
Standardit
Automaattisen järjestelmän käyttöopas -asiakirjan rakennetta ja sisältöä säätelee asiakirjan RD 50-34.698-90 (peruttu Rosstandartin 12.2.2019 N 216 antamalla määräyksellä) alakohta 3.4. Asiakirjojen Käyttöopas, Ohjelmoijan opas ja Järjestelmäohjelmoijan opas rakennetta ja sisältöä säätelevät GOST 19.505-79 , GOST 19.504-79 ja GOST 19.503-79.
- Joukko standardeja ja ohjeita automatisoiduille järjestelmille (GOST 34)
- RD 50-34.698-90 AUTOMAATTIJÄRJESTELMÄT. ASIAKIRJOJEN SISÄLTÖÄ KOSKEVAT VAATIMUKSET
- Unified System for Design Documentation (ESKD) määrittelee asiakirjan "Operating Manual" ja muut asiakirjat:
- Unified Program Documentation System (ESPD) määrittelee asiakirjat "Operator's Manual", "Maintenance Manual" ja niiden rakenteen:
- GOST 19.101-77 Ohjelmatyypit ja ohjelmaasiakirjat
- GOST 19.105-78 Yleiset vaatimukset ohjelmaasiakirjoille
- GOST 19.505-79 Käyttöohje. Sisällön ja suunnittelun vaatimukset
- GOST 19.508-79 Huoltokäsikirja. Sisällön ja suunnittelun vaatimukset
Katso myös
Linkit