Millä ohjelmalla on parempi kirjoittaa ohjeet? Kuinka kirjoittaa ohjeet tyhjästä

Artikkeli on omistettu yleiset periaatteet sääntelyasiakirjojen laatiminen, erityisesti säännökset rakenteelliset jaot, työtoiminnan suorittamista koskevat määräykset ja henkilökohtaiset toimenkuvat. Tässä artikkelissa käsitellyt kaksitoista sääntelyasiakirjojen laatimissääntöä auttavat sinua tekemään asiakirjoista selkeitä ja sopivia käytettäväksi oikea elämä.

Tämä artikkeli keskittyy yritysten kirjallisiin toimintaperiaatteisiin. Tällaisia asiakirjoja on kolme päätyyppiä: rakenneyksiköitä koskevat määräykset, työtoiminnan suorittamista koskevat määräykset ja henkilökohtaiset toimenkuvat. Itse asiassa kirjoitustekniikan näkökulmasta alajakomääräysten ja käyttömääräysten välillä ei ole eroa. Jos jokin työprosessi on organisoitu yksinkertaisesti, suoraviivaisesti, kuten hihnakuljettimella, niin se on helpompi kuvata erityismääräysten avulla. Jos päinvastoin tulos on peräisin syvyyksistä työryhmä(rakenneyksikkö) huonosti formalisoitujen vuorovaikutusten (inspiraatio, luova teko, aivoriihi jne.) jälkeen, silloin on helpompi käyttää rakenneyksikön lausunnon mallia. Molempien asiakirjojen rakenne säilyy lähes ennallaan, vain määräyksissä keskitytään työn suorittamisen muodollisiin kriteereihin kussakin vaiheessa (kun työ ja vastuu siirretään alihankkijalle) ja määräykset kertovat enemmän työn yleisistä tavoitteista ja tavoitteista. osasto. Mitä tulee henkilökohtaisiin työnkuvauksiin, ne ovat yksinkertaisesti ote, joskus hieman yksityiskohtaisempia, kahden ensimmäisen tyypin asiakirjoista.

Artikkeli on omistettu sääntelyasiakirjojen laatimisen yleisille periaatteille, ei niiden lajikkeille, joten tekstissä sanoja "asiakirjat", "määräykset", "määräykset" ja "ohjeet" käytetään usein synonyymeinä. Nyt mennään asiaan.

Miksi on ohjeita: Mitä tehdä? ja kuka on syyllinen?

Kaikki ovat yhtä mieltä siitä, että minkä tahansa sääntelyasiakirjan tärkeimmät edut ovat lyhyys ja selkeys. On aivan selvää, että epäselvää, toisin sanoen moniselitteistä tai ristiriitaista asiakirjaa on yksinkertaisesti mahdoton toteuttaa. On myös ilmeistä, että pitkän asiakirjan käyttäminen on hankalaa - se on tylsää lukea, vaikea navigoida ja helppo unohtaa jotain tärkeää. Lisäksi mitä pidempi ohje on, sitä suurempi on yhteensopimattomien tai moniselitteisten määräysten todennäköisyys. Kaikki tietävät tämän, mutta useimmat työnkuvat ovat pitkiä ja epäselviä. Mikä hätänä?

Useimmat sääntelyasiakirjojen kirjoittajat eivät täysin ymmärrä, mitä ohje on. Suurin osa johtajista, jotka tilaavat näitä säädösasiakirjoja, ei myöskään ymmärrä tätä. Sekä johtajat että toimeenpanijat pyrkivät aliarvioimaan ja samalla liioittelemaan kirjallisten normatiivisten asiakirjojen kykyjä. Toisaalta he aliarvioivat virallisia ohjeita uskoen, että pomon karjunta riittää oikaisemaan alaisten mielet ja ohjaamaan heidät oikealle tielle. Toisaalta he uskovat naiivisti, että ohjeet voivat korvata tämän erittäin määrätietoisen karjun silloin, kun esiintyjä putoaa johdon näkyvistä. Molemmat väärinkäsitykset johtuvat nöyrän roolin väärinymmärryksestä työnkuvaus suuren organisaation johdossa.

Itse asiassa normatiivisen asiakirjan ainoa tarkoitus on vastata toimeenpanijan kysymykseen "Mitä tehdä?" ennen työn aloittamista ja johtajan kysymykseen "Kuka on syyllinen?" siinä tapauksessa, että saatu tulos ei ole sama kuin aiottu tulos. Kaikki muu tulisi häikäilemättömästi poistaa ohjeista. Tämä ensimmäinen sääntö.

Opetuksen tarkoitus on selittää alaiselle, mitä häneltä vaaditaan. Motivoi alainen tekemään niin työvastuudet ohjeita ei voi!

Ensinnäkin, luovu illuusio siitä, että alainen ryntää ohjeet luettuaan toteuttamaan ne. Ei ollenkaan, johtajan täytyy motivoida häntä tähän. Motivaatiomenetelmät voivat olla parempia tai huonompia. Voit huutaa alaiselle, maksaa hänelle bonuksen, luvata ylennyksen tai uhata häntä irtisanomisella ja niin edelleen. On tärkeää, että tällä kaikella ei ole mitään tekemistä hänen työnkuvansa kanssa. Tehtävänkuvauksen läsnäolo vapauttaa johtajan tarpeesta määritellä yksityiskohtaisesti alaisensa tehtävät joka kerta ja antaa hänelle mahdollisuuden keskittyä koulutustyöhön.

Jos tämä on selvää, voit aloittaa asiakirjan "puhdistuksen". Jätä työnkuvasta pois kaikki vetoomukset, toiveet, ilmaisut kuten "esittäjä on velvollinen...", "esittäjän täytyy...". Kaikki tämä on tarpeetonta. Työnkuvauksen tulee sisältää mahdollisimman yksinkertaisia lauseita: "Hän juoksi...", "Hän juoksi...". Yksi ohjeen kohta ei ole yhtä tärkeä kuin mikään muu, joten joitain niistä ei tarvitse korostaa värikkäillä lauseilla. Yritä heittää tämä roskat pois, niin näet sen normiasiakirja tulee 20 prosenttia lyhyemmäksi ja paljon selkeämmäksi. Tämä toinen sääntö.

Muista: kirjoitat ohjeita tietyille ihmisille

Toinen ääripää, johon työnkuvan kirjoittajat usein lankeavat, on mania kuvata kaikkea ja kaikkia. Joskus saa sellaisen vaikutelman, että ohjeet on koottu pienille lapsille tai päinvastoin pahantahtoisille sabotoijille, jotka vain ajattelevat, kuinka vääristää johdon jalo tarkoitus ja muuttaa se pahaksi.

Yleensä tällaiset pelot ovat täysin perusteettomia. Organisaatiosi henkilöillä on todennäköisesti vilpitön halu suorittaa tehtävänsä tunnollisesti. Heille riittää, että he selittävät selvästi toimintansa tarkoituksen, ja he löytävät itse sopivat keinot! Tämä kolmas sääntö. Huomaa: organisaation monimutkaisimmat ja vastuullisimmat toiminnot suorittavat pätevimmät ja kokeneimmat asiantuntijat, joten he tarvitsevat muita harvemmin pitkiä, yksityiskohtaisia ja ytimekkäitä ohjeita. Kuvittele henkilö, jolle kirjoitat ohjeita - ja kevyellä sydämellä vähennät sen puolitoista kertaa! Jos näin ei ole, niin ehkä sinun pitäisi kiinnittää huomiota henkilöstön valintaan?

Paradoksina on se, että ydinvoimalaitoksen talonmiehen ja operaattorin toimenkuvat ovat lähes yhtä pitkiä!

Tavoitteet, tavoitteet, toiminnot: yleisestä erityiseen

Joten kaikki tarpeettomat epiteetit ja vetoomukset tulisi sulkea pois normatiivisesta asiakirjasta, samoin kuin kaikki, mitä esiintyjä tietää ilman ohjeita pelkästään koulutuksensa, pätevyytensä ja kokemuksensa perusteella. Mitä sinne pitäisi jäädä?

1 jakso "Yleiset määräykset". Tämän osion sisältö määräytyy täysin kunkin organisaation perinteiden mukaan, eikä sillä käytännössä ole vaikutusta itse asiakirjan laatuun. Jokaisella lakimiehellä tai henkilöstövirkailijalla on oma käsityksensä siitä, miltä tämän osion tulisi näyttää. Jätetään se heidän harkintaan. Huomaamme vain, että tämän osion tulisi olla yhtenäinen kaikissa yritysasiakirjoissa. Jos näin ei tapahdu, ei itse muotoilut ole tärkeitä, vaan niiden erot. Miksi tarvitset sitä?

Viimeinen osa on "Loppumääräykset". Sama.

Osa 2 "Tavoitteet ja tavoitteet". Normaali asiakirja alkaa itse asiassa tällä jaksolla. Jos yleiset ja loppumääräykset voidaan kirjoittaa "autopilotilla" tai yksinkertaisesti lainata toisesta asiakirjasta, sinun on aloitettava "Tavoitteet ja tavoitteet" ymmärtämällä selkeästi, miksi otit tämän asiakirjan käyttöön. Seuraava osio ”Toiminnot” voidaan antaa alaisen hoidettavaksi, joka suorittaa näitä tehtäviä jatkossa, mutta ”Tavoitteet ja tavoitteet” on päätettävä esimiehen henkilökohtaisesti. Riippumatta siitä, kuinka tuskallinen tämä prosessi hänelle on, tämä on hänen päätehtävänsä.

Kuinka muotoilla tavoitteet oikein?

Sääntö neljä. Tavoitteiden tulee olla samassa mittakaavassa. Muista anekdootti tapaamisesta, jossa kaksi asiaa oli esityslistalla: 1) navetan kunnostaminen ja 2) kommunismin rakentaminen. Ajattele sitä, jos kirjoitat ohjeita kommunismin rakentamiseen, niin miksi tarvitset navetta? Ja jos se on navetan korjaamista, niin mitä tekemistä kommunismilla on sen kanssa?

Sääntö viisi. Vältä toissijaisten tai sivutavoitteiden määrittämistä. Oletetaan, että polkusi seuraa reittiä A - B - C. Jos asetit tavoitteeksi pisteen C, älä mainitse pistettä B, olet joka tapauksessa perillä!

Sääntö kuusi. Vältä toisiinsa liittymättömiä tai, mikä pahempaa, ristiriitaisia tavoitteita.

Lopuksi tavoitteista: älä pelkää julistavia tavoitteita. Tavoite voi olla täysin saavuttamaton. Jos käytämme analogiaa Combat Manualin kanssa, niin tavoitteena on niin sanottu "edemmän liikkeen suunta" hyökkäyksen taistelujärjestyksessä. On tärkeää, etteivät alaiset sekoita takaosaa etupuolelle, kaikki muu on yksityiskohtia.

Nyt tehtävistä.

Sääntö seitsemän. Toisin kuin tavoitteet, tavoitteiden tulee olla saavutettavissa. Lisäksi tavoitteiden tulee olla mitattavissa! Annettujen tehtävien suorittaminen tulee mitata kappaleissa, tonneissa tai kilometreissä organisaation erityispiirteiden mukaan.

Sulje silmäsi ja kuvittele alainen, jolle olet juuri ilmoittanut tavoitteesi ja antanut juuri nämä tehtävät. Kuvittele nyt, että hän jonkin ajan kuluttua raportoi näiden tehtävien suorittamisesta. Mitä todisteita onnistuneesta työstä odotat häneltä? Jos et itse osaa kuvitella, kuinka alaisensi raportoi tehdystä työstä, olet asettanut tehtävän huonosti!

Muista: muotoilemalla tehtävän määrität siten raportointimuodon!

Sääntö kahdeksan. Tavoitteiden tulee vastata tavoitteita. Jokainen tavoite voi vastata useita välittömiä tehtäviä. Jokainen tehtävä voi johtaa useiden tavoitteiden saavuttamiseen. Tämä on hyvä. Mutta mitä ei voi olla, on tehtävä, joka ei johda ainakaan yhteen aiemmin asetetuista tavoitteista. Ei myöskään voi olla niin, että aiemmin asetettua tavoitetta varten ei ole vähintään yhtä tiettyä tehtävää.

Jatkamalla analogiaa taistelukäsikirjan kanssa, huomaamme, että tavoitteet ja tavoitteet korreloivat hyökkäyksen kohteena (hyökkäys) jatkoliikkeen suunnan kanssa. Yksinkertaisesti sanottuna tietty tehtävä ei voi olla täysin erillään yleisestä tavoitteesta.

Osio 3 “Toiminnot” vie noin 60 prosenttia koko asiakirjasta. Tämä on sääntelyasiakirjan tärkein osa. Jos olet kuitenkin muotoillut tavoitteesi ja tavoitteesi oikein, sinulla ei ole vaikeuksia kuvailla toimintoja.

Sääntö yhdeksän. Tehtävät ja toiminnot liittyvät samalla tavalla kuin tavoitteet ja tavoitteet. Kuvittele itse pomo, osaston johtaja ja esiintyvä asiantuntija. Se, mitä pomo ilmoitti pomolle erityistehtävänä, on asiantuntijalle yleinen tavoite, johon hän pyrkii, mutta josta hän ei ole henkilökohtaisesti vastuussa. Hänen tietty tehtävä tulee jotain, joka osoittaa sen hänelle Lähin esimies, eli juuri sitä, mitä kutsutaan "toiminnoksi" sääntelyasiakirjassa.

Toistetaan säännöt seitsemän ja kahdeksan. Funktioiden tulee olla toteutettavissa, eli funktio on muotoiltava niin, että missä tahansa erityinen tilanne kysymykseen: "tehty vai ei" voitaisiin vastata yksitavuisina. Kyllä - kyllä, ei - ei, ja kaikki tämän lisäksi on "pahasta". Toimintojen on vastattava tehtäviä. Ajattele sitä, jos alaisensi suorittaa kaikki hänelle osoitetut tehtävät, pystytkö laatimaan hyväksyttävän raportin pomolle?

Pysähdytään nyt työnkuvausten laatimistekniikan kielellisiin, niin sanotusti, puoliin.

Sääntö kymmenen. Kun muotoilet tavoitteita, tavoitteita ja toimintoja, käytä samaa lauserakennetta. Esimerkki lähimenneisyydestä:

kiihtyvyys maan kehitys;

kiivetä massojen työvoima;

muodostus uusi henkilö;

lausunto sosialistinen elämäntapa.

Asiaankuuluvat tehtävät:

nostaa Neuvostoliiton ihmisten hyvinvointi laadullisesti uudelle tasolle;

tarjota aineellisten, sosiaalisten ja kulttuuristen hyödykkeiden kulutuksen taso ja rakenne, joka...

Määritetyistä tavoitteista ja tavoitteista johtuvat toiminnot (toiminnot):

Suunnitelmissa on kaksinkertaistaa myönnettyjen resurssien määrä...

puolue kiinnittää erityinen merkitys vahvistuminen...

joukko toimenpiteitä on toteutettava...

viiva vedetään...

Kaikki tarvittava tehdään...

Nopeutettu kasvu ja jakelun parannukset jatkuvat...

Puolueen mielestä se on ensiarvoisen tärkeä tehtävä...

Suunnitelmissa on toteuttaa suuria toimenpiteitä nykyaikaisen palvelusektorin luomiseksi,

Puolue pitää yhteiskunnallisesti erityisen tärkeänä asiana asunto-ongelman ratkaisun nopeuttamista ja niin edelleen.

Huomaa: tavoitteet on muotoiltu lauseilla, joissa on substantiivit ja ei predikaattiverbejä. Tehtävät muotoillaan eri tavalla - käyttämällä verbejä määrittelemättömässä muodossa. Toimintoja muotoiltaessa käytettiin useita konstruktioita: "suunniteltu/on tehdä niin ja niin", "tätä ja sellaista tehdään", "puolue pitää sitä ja sellaista tärkeimpänä asiana/tehtävänä". Ehkä eroilla on jokin peruste, tai ehkä se kaikki johtuu vain kauneudesta. Jos et kirjoita uusi ohjelma CPSU, silloin on parempi pidättäytyä tarpeettomasta kauneudesta.

Miksi on tärkeää pitää kiinni yhdestä tyylistä? Kyllä, yksinkertaisesti siksi, että tyylillinen epäjohdonmukaisuus häiritsee ohjattua henkilöä, saa hänet miettimään, onko tässä piilotettu merkitys? Miksi vaivata päätäsi tarpeettomilla asioilla - kirjoita yksinkertaisemmin!

Sääntö yksitoista. Ohjeiden tulee olla kattavat, eli niissä on kuvattava kaikki toimet, joita alaiselta voidaan vaatia. Kuinka varmistaa, että kaikki on kunnossa tämän kanssa?

On yksi tekniikka. Sisällytä työmenettelysääntöihin kohta ”Virkamiesten vastuut näiden määräysten toimeenpanossa”. Kirjoita huolellisesti muistiin kaikki tavoitteet ja tavoitteet ja toiminnot -osioissa mainitut toimihenkilöt. Jaa kaikki tehtävät huolellisesti näiden virkamiesten kesken. Onko jäljellä ylimääräisiä toimintoja, joista ei ole selvää, kuka ne suorittaa? Onko jäljellä virkamiehiä, jotka eivät saaneet yhtäkään tehtävää?

Huomaa, että säädösasiakirjajärjestelmä on kokonaisvaltainen järjestelmä. Rakenneyksiköitä koskevien määräysten tulee olla yhdenmukaisia työtoimintaa koskevien määräysten kanssa. Henkilökohtaiset toimenkuvat edustavat pohjimmiltaan yhtä yksikköä koskevien määräysten osioista, jotka on laadittu erilliseksi asiakirjaksi pelkästään käyttäjien avuksi. Siksi yritä käyttää samaa sanamuotoa kaikissa asiakirjoissa - katso sääntö kymmenen.

Sääntö kaksitoista. Ihmiset ovat olemassa tekemään päätöksiä. Monet ohjeiden kirjoittajat yrittävät kuvata tilannetta, jossa kaikki on normaalia. Mutta ohjeita tarvitaan juuri sillä hetkellä, kun jokin menee pieleen. Suurin osa ohjeista epäonnistuu tässä vaiheessa. Mitä tehdä?

Hätätilanteessa voi olla vain kaksi reaktiota: tee päätös itse tai ilmoita "käskystä". Jos epäröit uskoa suoraan alaisensa tekemään tiettyjä päätöksiä, älä epäröi sisällyttää toimenkuvaan hätäilmoitusvelvollisuus. Säästä alainen Buridanin perseelle. Erityisen tärkeää on varmistaa toimintamenettelyjen eheys. Käytä aikaa koko prosessin vuokaavion piirtämiseen. Varmista, että jokaisessa haarukassa on selkeä opastus siitä, mitä tehdä: luovuta työ eteenpäin, lähetä se takaisin, välitä se korkeammalle taholle tai heitä se roskakoriin.

Tutkimme kaksitoista sääntöä säädösasiakirjojen laatimisesta. Näiden sääntöjen noudattaminen tekee säännöistä selkeitä ja käyttökelpoisia tosielämässä. Mitä tulee lyhyyteen, niin annetaan esimerkki. Kirjoittajan oli analysoitava ohjeet liikepankille lainaamisesta. Alkuperäinen teksti koostui 13 026 sanasta tai 92 187 merkistä. Käsittelyn jälkeen teksti pienennettiin 6011 sanaan (42 246 merkkiä).

Valitettavasti tiiviiden ja selkeiden sääntelyasiakirjojen laatimisen ongelma ei rajoitu pelkästään teknisten kysymysten ratkaisemiseen. Useimmissa tapauksissa sekä asiakkaat että asiakirjojen kirjoittajat "sumentavat" ja "paisuttavat" työnkuvauksia tarkoituksella, vaikkakin tiedostamatta. Siten he luovat suhteeseen tietyn "leikin". Sekä esimiehet että alaiset saavat mahdollisuuden liikkua. Esimiehet vapautuvat tarpeesta asettaa tehtävät selkeästi, alaiset vapautetaan tarpeesta suorittaa ne virheettömästi ja molemmat vapautuvat tarpeesta olla vastuussa työstään.

Perustuu www.emsi.ru materiaaliin

Artikkeli toimitettu portaaliimme
lehden toimitukselle

Viitetietoja voidaan tarjota käyttäjälle monella tapaa – nämä ovat FAQ (usein kysytyt kysymykset, usein kysytyt kysymykset), online-ohje ja käyttöopas (käyttöopas) ja nykypäivän suositut vinkit (valmentajat, katso esimerkki alla), koulutusvideot ja muut .

Olla olemassa eri syistä, jota varten sinun on kirjoitettava järjestelmän käyttöopas. Alkaen asiakkaan pyynnöistä (käytännössäni oli tapaus, jossa asiakkaan piti toimittaa käyttöopas jokaisen iteroinnin jälkeen, jotta hän pystyi sen avulla suorittamaan iteraation toimivuuden hyväksymistestauksen) ja päättyen sopimusehtoihin. koskien valmiiden ohjelmistojen toimittamista, jos puhumme ohjelmistokehityksestä tilauksesta. Oman tuotteen kehittämisessä tapahtuu usein myös käyttöoppaan kirjoittamista.

Analyytikko on usein mukana laatimassa käsikirjaa, jos sitä ei ole mahdollista delegoida tekniselle kirjoittajalle. Suurimmassa osassa tapauksia analyytikko on se, jolla on täydellisin tieto järjestelmästä, ja hänellä on myös kyky ilmaista ajatuksensa selkeästi kirjallisesti ammatin erityispiirteistä johtuen. Siksi olen joutunut käsittelemään käyttöoppaiden luomista useammin kuin kerran.

Alla on joitain käytäntöjä hyvän käyttöoppaan kirjoittamiseen. Jotkut niistä voivat olla hyödyllisiä jollekulle vaatimusmäärityksiä kirjoittaessaan.

1. Standardit

Usein on tarpeen kirjoittaa asiakirja, joka täyttää nykyisten standardien vaatimukset. Se voi olla:

IEEE Std 1063-2001, "IEEE Standard for Software User Documentation";
GOST 19:
- GOST 19.402-78 ESPD. Ohjelman kuvaus;
- GOST 19.502-78 ESPD. yleinen kuvaus. Sisällön ja suunnittelun vaatimukset;
- GOST 19.503-79 ESPD. Järjestelmäohjelmoijan opas. Sisällön ja suunnittelun vaatimukset;
- GOST 19.504-79 ESPD. Ohjelmoijan opas. Sisällön ja suunnittelun vaatimukset;
- GOST 19.505-79 ESPD. Käyttöohje. Sisällön ja suunnittelun vaatimukset.

Jos projektin tarpeet sallivat sinun olla noudattamatta tiukkoja standardeja, näiden asiakirjojen tutkiminen voi joka tapauksessa toimia lähtökohtana laadukkaan asiakirjan kirjoittamiselle.

Juri Kagarlitskyn kirjasta MetaGuide voi myös olla hyötyä. Ohjelmiston teknisen dokumentaation kehittäjille.

2. Rakenne

Mieti huolellisesti asiakirjan rakennetta: sen tulee kattaa kaikki järjestelmän toiminnot, olla täydellinen ja ymmärrettävä.

Hyvän käyttöohjeen tulee sisältää:

Abstrakti, joka tarjoaa yhteenveto asiakirjan sisältö ja tarkoitus. On myös suositeltavaa kirjoittaa lyhyt yhteenveto jokaisen suuren osan alkuun.
Johdanto, joka sisältää tietoa tämän oppaan parhaasta käytöstä.
Sisältö
Luvut, jossa kuvataan miten käyttää BY
Sanasto Ja
Aihehakemisto

Käyttöopas voi sisältää myös:

FAQ ja vastaukset niihin
Linkit päällä Lisäinformaatio järjestelmän mukaan
Luku, kuvailee mahdollista Ongelmia ja tapoja ratkaista ne

On parempi numeroida kaikki luvut ja kappaleet sekä kuvat ja taulukot, jotta niihin voidaan viitata tässä asiakirjassa tai toisesta asiakirjasta.

3. Käyttäjät

Ajattele tämän ohjelmiston tyypillisiä käyttäjiä: haluat asiakirjan auttavan heitä ratkaisemaan päivittäiset ongelmansa.

Saattaa jopa olla järkevää luoda eri osioita (tai jopa erilaisia asiakirjoja) eri käyttäjäryhmille, jos heidän vuorovaikutuksensa järjestelmän kanssa on radikaalisti erilaista. Esimerkiksi järjestelmänvalvojat (tileistä, käyttöoikeuksista jne. vastaavat henkilöt) ovat kiinnostuneita täysin erilaisista toiminnoista kuin tavalliset käyttäjät.

Kunnioita järjestelmän käyttäjiä, älä kirjoita ohjeita halventavaan tyyliin.

4. Esityksen ominaisuudet

Muista, että esitystyyli suullisessa puheessa tai in liikekirje eroaa tästä teknisessä dokumentaatiossa ja erityisesti käyttöohjeessa.

Käsikirjan tyylin tulee olla neutraali ja muodollinen - tyylillisesti väritettyjen sanojen käyttö häiritsee käyttäjää olemuksesta.

Kääntää hyvä dokumentti kieliopin tuntemus ja vähän psykologiaa ovat hyödyksi.

4.1 Kirjoita lyhyesti ja loogisesti.Älä anna tarpeettomia yksityiskohtia, älä toista tietoja. Tietojen mainitsemisjärjestyksen käyttöoppaassa on oltava sama kuin käyttäjän toimintojen järjestys:

Hieno: Valitse Tiedosto-valikosta Tallentaakohde.
Huonompi: Valitse Tallentaa kohta Tiedosto-valikosta.

4.2 Käytä pakottavaa tunnelmaa, älä käytä kohteliaita ilmaisuja (ole hyvä, voisi jne.) - liiallinen kohteliaisuus on tässä esteenä.

Hieno: Klikkaus Kirjautua ulos.

Huonompi: Se on napsautettava Kirjautua ulos kirjautuaksesi ulos nykyisen käyttäjätilin järjestelmästä .

Huonompi: Jos käyttäjä haluaa kirjautua ulos nykyisen käyttäjätilin järjestelmistä, hänen on napsautettava Kirjautua ulos.

4.3 Rakennetiedot. Usein voi törmätä neuvoihin, että listoja kannattaa yrittää välttää, mutta askel askeleelta jäsennelty tieto on aina paremmin havaittavissa.

Hieno:
Vastaanottajaluodahanke:

Klikkaa Luoda-painiketta työkalupalkissa.
Käytössä Luoda Projekti peittokuva täytä kaikki pakolliset kentät.
Klikkaa Tallentaa-painiketta tallentaaksesi projektin.

Huonompi: Luo projekti napsauttamalla Luoda-painiketta työkalupalkissa Luo projekti peittokuva täytä kaikki pakolliset kentät, napsauta Tallentaa-painiketta tallentaaksesi projektin.

4.4 Älä käytä tulevaa tai mennyttä aikaa. Usein on esimerkiksi käsikirjoja, joissa järjestelmän reaktio käyttäjän toimintaan välitetään tulevassa aikamuodossa muotoiltuina lauseina. Ohjelmistolla ei ole menneisyyttä tai tulevaisuutta: kaikki tapahtuu nykyisyydessä käyttäjän tietyn toiminnan suorana seurauksena. Heti kun tapahtuma tapahtuu, ohjelmisto reagoi.

Hieno: Kun käyttäjä napsauttaa alkaa painiketta, ohjelmaa alkaa prosessi.

Huonompi:Kun käyttäjä napsauttaa alkaa painiketta, ohjelmaa alkaa prosessi.

4.5 Tarkista sanojen merkitys. Jos sinun on kirjoitettava asiakirja vieras kieli, meidän on pyrittävä mahdollisimman paljon välttämään virheitä, jotka liittyvät riittämättömään kielen taitoon.

Esimerkiksi verbi "press" tarkoittaa näppäimistön näppäimen painamista, ja "napsauttaa" tarkoittaa painikkeen tai kuvakkeen painamista ohjelmaikkunassa hiirellä, ja "lyödä" on yleensä slangisana.

Kirjoitusvirheet eivät tietenkään ole hyväksyttäviä.

4.6 Älä käytä synonyymejä samalle termille. Englanninkielisessä (tai millä tahansa muulla) kielellä IT-kirjallisuudessa on vakiojoukko verbejä, jotka ilmaisevat toimintoja (napsauta, kaksoisnapsauta, valitse, kirjoita, paina jne.) ja samat standardijoukot ohjauselementtien nimiä. Päätä terminologiasta ja noudata sitä koko asiakirjan ajan.

Älä esimerkiksi salli avattavan luettelon nimeämistä dokumentin yhdessä osassa pudotusvalikosta ja toisessa täsmälleen samaa elementtiä - yhdistelmälaatikkoa tai avattavaa luetteloa. Tämä hämmentää käyttäjää.

4.7 Käytä lyhenteitä viisaasti ja vältä ammattislangia.

Uskotaan, että lyhenteitä ei pidä käyttää, mutta jos pitkää termiä käytetään useita kertoja, niin tekstin ensimmäisessä maininnassa tulee kirjoittaa koko nimi ja sen viereen - lyhenne suluissa ja edelleen tekstissä voi käyttää vain lyhennettä. Jos asiakirjassa on sanasto tai osa lyhenteistä, ne tulee selittää siellä.

Älä käytä ammattislangia, metaforia tai termejä, jotka on lainattu muulta kuin oppaan kieleltä.

5. Ulkonäkö

5.1 Mieti asiakirjan tyyliä. Tämä voi olla yrityksen malli tai väriskeema Ohjelmisto tai erityisesti asiakirjaa varten tehty malli.

Kirjoittaessasi voit korostaa tärkeitä asioita tyyleillä tai väreillä (esimerkiksi lihavoita painikkeiden nimet). Mutta on tärkeää ymmärtää, että väärin valitut fontit ja värit voivat vaikeuttaa asiakirjan sisällön havaitsemista.

5.2 Älä säästä tilaa– jaa teksti lyhyiksi kappaleiksi, käytä suhteellisen suuria otsikoita, aloita uusi osio uudelta sivulta. Tämä helpottaa tietojen lukemista.

5.3 Käytä kuvakkeita ja piirroksia. On olemassa mielipide, että sinun ei pidä hukata kuvituksiin ja sisällyttää myös kuvakkeet käyttöoppaan tekstiin. Graafiset tiedot havaitaan ja muistetaan kuitenkin aina paremmin, joten kuvakaappauksia ja tarvittavia kuvakkeita tulee olla hyvä johtajuus riittävinä mutta kohtuullisina määrinä.

6. Tuki

Älä unohda sitä tosiasiaa, että ohjelmisto muuttuu ajan myötä, mikä tarkoittaa, että myös asiakirjasi on muututtava pysyäkseen ajan tasalla.

Johtopäätös

Huomaa, että käyttäjä voi projisoida ohjelmistoon huonolaatuisen asiakirjan aiheuttamaa ärsytystä ja vaikuttaa siten tuotteen käyttöpäätökseen.

Muista tärkein asia: asiakirjan pitäisi auttaa käyttäjiä.

Valmisteli artikkelin

Nadezhda Tarasyuk, sivuston yhteisön jäsen,

analyytikko, jolla on 6 vuoden kokemus alalta.

Selvitä, kenelle ohjeita valmistellaan.

Kirjoitatko aloittelijoille, ammattilaisille tai jollekin, jolla on keskitason tietämys?
Opetustasi käytetään ryhmätunneilla tai Itsenäinen opiskelu?

Määritä tarkasti, mitä ohjeet sanovat.

Esimerkki: Olet valmistelemassa ovien asennusopasta. Yksi osa voi olla omistettu liukuoville, toinen sisäänkäynnin ovet, toinen - takasisäänkäynnin ovet.

Päätä, mikä looginen rakenne esität materiaalin sopii paremmin Kaikki yhteensä. Osion välinen suhde viittaa muuhun kuin vain toimintojen järjestykseen. Joskus on tarpeen sisällyttää ensin osio, joka kuvaa tiettyjä termejä ja käsitteitä, ja myös paremmin eri osioissa toistuvia tehtäviä. Mutta jos oletat, että lukijalla on jo tiettyjä taitoja tehtävän suorittamiseen, kuvaukset yleiset menettelyt On parempi antaa ne liitteissä.

Jos ohjeissa käytetään ammattiterminologiaa tai ammattislangia, sinun on laadittava termien sanasto. Jos lukijat eivät todennäköisesti tunne terminologiaa, on parasta sijoittaa sanasto heti sisällysluettelon jälkeen. Päivitä termiluettelo samalla kun kirjoitat ohjeita.

Sanastossa tulee käyttää tarkimpia termien kuvauksia. Jos käytetään lyhennettä, selitä sen merkitys (esimerkiksi Scuba – Self Contained Underwater Breathing Apparatus).

Päätä, mitkä aiheet vaativat lisätutkimusta. Jos ohjeet on laadittu huonosti, ne ovat hyödyttömiä. Alustava tutkimus tulee tehdä ennen kuin aloitat ohjeiden kirjoittamisen.

Mieti kunkin osion organisaatiorakennetta.

Esimerkki: Valmistelet ohjeita aiheesta tietyt tietokoneet. Tässä oppaassa voi olla Vianetsintä-osio. Osa sen materiaalista voi olla omistettu levytilan ongelmiin, osa liialliseen käyttöön RAM-muisti jne.

Järjestä jokainen osa ja osio loogiseen järjestykseen ja kavenna kunkin aiheen laajuutta.

Aloita kirjoittaminen! Käytä organisaatiojärjestelmää perustana, mutta voit vapaasti muokata sitä laajentaaksesi aihetta.

Kirjoita kuvaukset eri tehtävistä.
Valmista esimerkkejä, jotka auttavat lukijaa ymmärtämään ohjeet paremmin.
Valmistele sopivat kuvat. Älä lisää kuvia ennen kuin ohjeet on kirjoitettu. Kuvitukset on sovitettava tekstiin sopivaksi.

Tee muutoksia, jotta lukijan on helpompi löytää tarvitsemansa tiedot.
1. Esimerkki 1: (Käytä numeroitua listaa) Editorissa voit linkittää kuvan ohjeen kappaleeseen 13.
2. Esimerkki 2: (Lajittelu) Editorissa voit suurentaa tekstijonon kokoa, jos se erottuu yleisestä järjestyksestä.

Älä kopioi muiden ohjeita! Käytä hakemistoja ja bibliografiaa, josta käy ilmi, mistä lainatut tiedot ovat peräisin (muita kirjoittajia, ohjeita jne.).

Mikään ei tuhoa kirjoittajan uskottavuutta nopeammin kuin plagiointi. Mieti, miltä sinusta tuntuisi, kun joku "varastaa" osan työstäsi ohjeidensa vuoksi?

Lisää asiaankuuluvia kuvia. Sijoita ne tekstiin. Älä pelkää jättää tyhjää tilaa.

Tarkista, tarkista ja vielä kerran. Virheiden etsinnän tulee olla jatkuvaa. Tee muistiinpanoja löytämistäsi virheistä tai tiedoista, joita et kaipaa. Korjaa ne. Merkitse kappaleet, jotka vaikuttavat epäselviltä muut ihmiset. Kirjoita nämä kohdat uudelleen, jotta ne on helpompi ymmärtää. Antaa erilaiset ihmiset Lue ohjeet varmistaaksesi, että ne on kirjoitettu parhaalla mahdollisella tavalla.

- Mielestämme paras menettely valmiin ohjeen tarkistamiseksi on:
  1. Vähennä virheet itse.
  2. Pyydä ystävää tarkistamaan virheet.
  3. Anna alan asiantuntijan arvioida työsi, jotta hänkin voi arvioida sen.
  4. Jos käsikirjaa valmistellaan yrityksellesi, pyydä pomoasi tarkistamaan se.
  5. Anna työ aloittelijalle tarkistettavaksi.
  - Kokemattoman asiantuntijan suorittama tarkistus auttaa sinua ymmärtämään, kuinka selkeästi teksti esitetään ihmisille, joilla on vain vähän tietoa asiasta.

Onko lainausmerkin oikeinkirjoitus oikein: 1. maaliskuuta ilmestyi ohje ”Järjestämisestä turvallista käytöstä kuuma työ OJSC "Angarsk Petrochemical Companyn" osastoilla?


	Kysymys nro 238647

Mitä prepositiota tulee käyttää substantiivin "ohje" kanssa - "at", "by" jne.? Ja onko mahdollista ilman tekosyytä ollenkaan?