Sonat

Here you have access to some useful articles provided by Sonat.

Articles

V1.0.0

Sisäinen, ulkoinen, tuote-, prosessi-, tekninen ja käyttäjädokumentaatio

<h1>Sisäinen, ulkoinen, tuote-, prosessi-, tekninen ja käyttäjädokumentaatio</h1>Oletko aina tarvinnut selvennystä useilla termeillä, jotka viittaavat erilaisiin dokumentaatioihin? Tutustu seuraaviin kysymyksiin.Mitä käsikirja ja käyttäjän dokumentaatio tarkoittavat? Mikä on käyttöohje? Katsotaanko käyttöohjeen kirjoittamista tekniseksi dokumentaatioksi? Mitä eroa on koulutusoppaan ja käyttöohjeen välillä? Ulkoinen ja sisäinen dokumentaatio? Tuote- ja prosessidokumentaatio?Tässä luokittelemme ja määrittelemme kaikki nämä liittyvät termit järkevimmällä tavalla, jotta opit, kuinka ne ovat samanlaisia ​​tai erilaisia. Dokumentaatiotermejä voitaisiin kuitenkin käyttää vaihtokelpoisesti; Peitämme myös ne. Joten aloitetaan määrittelemällä tämän aiheen yleisin termi:<aside class="template-box extra-template-box" variant="extra"><div class="template-box-title">&nbsp;</div><div class="template-box-description">Saat lisätietoja <a href="https://sonat.com/@sonat/articles/what-exactly-is-a-user-manual-and-why-is-it-so-important-?lang=en">käyttöoppaan merkityksestä</a> yrityksellesi.</div></aside>&nbsp;<h2 id="dokumentointi">Dokumentointi</h2>&nbsp;Dokumentaatio on välitettävää materiaalia, joka tarjoaa muodollisesti tietoa järjestelmän, tuotteen, palvelun, organisaation, menettelyn tai teknisen prosessin esittelyä, kuvausta, koulutusta ja ohjeita varten. Monissa tapauksissa nämä muodolliset ja informatiiviset asiakirjat tunnetaan myös käsikirjoina.Mennään seuraavalle tasolle.Kun puhutaan tuotteesta tai palvelusta, hyvä luokittelu voi jakaa dokumentaation tai käsikirjat kahteen pääryhmään; Tekninen dokumentaatio ja käyttäjädokumentaatio . Toinen luokka voi jakaa asiakirjat tuotedokumentaatioon ja prosessidokumentaatioon, kuten ensimmäinen luokka. Toinen järkevä tapa luokitella dokumentaatio erityisesti organisaation asetuksista on järjestää dokumentaatio sisäisen vai ulkoisen perusteella.Keskustelemme niistä kaikista ja aloitamme laajimmasta.<h3>Ulkoinen dokumentaatio <img class="image-style-align-right" src="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/b7d147a6-9112-4fa8-979a-c118c53c9d9d.webp" alt="Ulkoinen dokumentaatio" srcset="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/b7d147a6-9112-4fa8-979a-c118c53c9d9d.webp?width=320 320w, /api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/b7d147a6-9112-4fa8-979a-c118c53c9d9d.webp?width=350 350w" sizes="100vw" width="350"></h3>Kuten nimestä voi päätellä, ulkoinen dokumentaatio on tarkoitettu jaettavaksi organisaation (yrityksen, liiketoimintayksikön jne.) ulkopuolisille ihmisille, jotta ne tarjoavat tuotetta tai palvelua koskevia tietoja ja oppaita. Siksi ulkoista dokumentaatiota voitaisiin kutsua myös tuotedokumentaatioksi. Yrityksen ulkoinen/tuotedokumentaatio voitaisiin jakaa käyttäjädokumentaatioon ja järjestelmädokumentaatioon .<h4 style="text-align:justify;">A. Käyttäjän dokumentaatio</h4>Käyttäjädokumentaatio, joka tunnetaan myös nimellä End-user Documentation, on tarkoitettu loppukäyttäjille tarjoamaan kattavaa tietoa tuotteesta tai palvelusta. Tämän ryhmän asiakirjoja voidaan kutsua myös käyttäjäavuksi. Niiden ensisijaisena tarkoituksena on auttaa käyttäjiä antamalla hyödyllistä tietoa tuotteesta, kuten yleisesittelystä, sen ominaisuuksien kuvauksesta sekä asennus-, käyttö- ja huolto-ohjeista.Tämän ryhmän käsikirjat opettavat aineita jollain teknisellä selityksellä. Silti, koska kohteena ovat loppukäyttäjät, heidän on rajoitettava yksityiskohtaisia ​​teknisiä tietoja ja käytettävä yksinkertaista kieltä vakiotermeillä ja ilmaisuilla teknisen ammattikieltä. Siksi ne tarjoavat käyttäjäystävällisiä oppaita ja vaiheittaisia ​​ohjeita käytännön käyttöä varten. Vaikka käyttäjädokumentaatio onkin <a href="https://sonat.com/@sonat/articles/who-is-a-technical-writer?lang=en">teknisen kirjoittajan</a> (joka käyttää teknisiä tietoja, ymmärtää ne ja kääntää ne lyhyemmäksi ja yksinkertaisemmaksi sisällöksi loppukäyttäjille) -valtaa, sitä ei aina pidetä teknisenä dokumentaationa. Koska ne eivät yleensä kohdistu asiantuntijoihin ja ammattilaisiin. Käsittelemme teknisiä asiakirjoja myöhemmin tässä artikkelissa.<aside class="template-box extra-template-box" variant="extra"><div class="template-box-title">&nbsp;</div><div class="template-box-description">Yllättävän yksinkertainen tapa luoda käyttöopas <a href="https://sonat.com/features/">Sonatin ilmaisilla käyttöohjemalleilla</a> .</div></aside>Tarkastellaan erilaisia ​​käyttäjädokumentaatiomuotoja:<ul><li>Asennus- ja asennusopas<ul><li>Asennus- ja asennusopas sisältää yksityiskohtaisia ​​tietoja tuotteen asennuksesta, määrittämisestä ja käynnistämisestä.</li></ul></li><li>Käyttöopas<ul><li>Käyttöopas, joka opastaa käyttäjiä käyttämään tuotetta oikein.</li></ul></li><li>Vianmääritysopas<ul><li>Käsikirja, jossa käsitellään tuotteen yleisten ongelmien korjaamista.</li></ul></li><li>Ohjekirja<ul><li>Tyypillinen käyttöopas sisältää usein kaikki edellä mainitut oppaat yhdessä paikassa. Käyttöoppaat keskittyvät eri käyttäjiin, mukaan lukien ammattitaitoiset ja kouluttamattomat, antaen ohjeita tuotteen asennuksesta, käytöstä ja ylläpidosta. He esittelevät tuotteen käyttäjille ja esittelevät sen vakiotoiminnallisuutta sekä sen erilaisia ​​ominaisuuksia ja sovelluksia. Ne sisältävät yleensä tuotteen käyttöön liittyviä varotoimia, ja ne voivat sisältää myös usein kysyttyjä kysymyksiä ja vianetsintäohjeita.</li></ul></li></ul>&nbsp;<h4 style="text-align:justify;">B. Järjestelmän dokumentaatio <img class="image-style-align-right" src="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/e8b3fdd5-e39f-46cf-ae19-729b487a0572.webp" alt="Järjestelmän dokumentaatio" srcset="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/e8b3fdd5-e39f-46cf-ae19-729b487a0572.webp?width=320 320w, /api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/e8b3fdd5-e39f-46cf-ae19-729b487a0572.webp?width=400 400w" sizes="100vw" width="400"></h4>Järjestelmän dokumentaatio voi olla huolto- tai korjauskäsikirja . Järjestelmän dokumentaatio sisältää yleiskatsauksen taustalla olevista järjestelmistä, tarkempia teknisiä tietoja ja korjausohjeita, jotka auttavat mekaanikoita, insinöörejä ja muita edistyneitä käyttäjiä korjaamaan tuotteen.<h3 style="text-align:justify;">&nbsp;</h3><h3 style="text-align:justify;">&nbsp;</h3><h3 style="text-align:justify;">&nbsp;</h3><h3 style="text-align:justify;">&nbsp;</h3><h3 style="text-align:justify;">Sisäinen dokumentaatio</h3>Sisäistä dokumentaatiota ei ole tarkoitettu jaettavaksi ulkopuolisille. Se sisältää teknisiä yksityiskohtia ja organisaatiopolitiikkaa, menettelytapoja jne., jotka ovat käyttäjille tarpeettomia tai tuottavia. Yleensä tämän ryhmän asiakirjat toimivat viitteenä työntekijöille, teknisille ryhmille, esimiehille tai muille toimistotyöntekijöille, jotta he voivat tehdä työnsä tehokkaammin. Kuten edellä mainittiin, sisäinen dokumentaatio voidaan jakaa tekniseen/prosessidokumentaatioon ja organisaation tukidokumentaatioon .&nbsp;<h4 style="text-align:justify;">A. Tekninen dokumentaatio</h4>Kun käytämme termiä <a href="https://sonat.com/@sonat/articles/who-is-a-technical-writer?lang=en">tekninen dokumentaatio</a> , tarkoitamme niitä sisäisiä asiakirjoja, jotka jaetaan pääasiassa organisaation teknisen tiimin kesken. Ne kattavat esimerkiksi testisuunnitelmat, kehitysprosessit, suunnitteluspesifikaatiot, projektisuunnitelmat, järjestelmän ylläpidon ja parantamisen jne. sekä monia teknisiä termejä. Termi Process Documentation viittaa melkein samanlaisiin asiakirjoihin. Teknistä ja prosessidokumentaatiota voidaan käyttää vaihtokelpoisesti.&nbsp;<h4 style="text-align:justify;">B. Organisaation tukidokumentaatio</h4>Jokaisessa organisaatiossa on erilaisia ​​käsikirjoja ja dokumentaatiota työntekijöiden kouluttamiseen ja organisaation sisäisten ohjeiden määrittämiseen, ja suurin osa näistä asiakirjoista kuuluu <a href="https://resources.workable.com/hr-manager-job-description">HR-alueeseen</a> . Keskustellaan joistakin yleisimmistä manuaalisiin termeistä, joita kohtaat organisaatiossa:1. Käyttöopas:Tämä käsikirja sisältää yrityksen standardeja ja ohjeita, joissa hahmotellaan mitä ja miten pitäisi tehdä. Siksi se auttaa henkilöstöä tekemään työnsä oikein ja tehokkaammin erityisesti tavaroiden ja palveluiden laadun ja turvallisuuden osalta.2. Kriisinhallintaopas:Se on manuaalinen ohje, jolla opastetaan työntekijöitä reagoimaan työpaikan kriiseihin.3. Tarkastuskäsikirja:Se kuvaa yrityksen tilintarkastuspolitiikkaa ja -menettelyjä.4. Koulutusopas:Koulutuskäsikirja on ensisijaisesti suunniteltu parantamaan suoritettuja tehtäviä, ja se voi sisältää ohjeita työntekijöiden kouluttamiseen. Koulutusoppaita voidaan käyttää sekä aloittelijoille että tutuille/kokeneemmille työntekijöille.<aside class="template-box extra-template-box" variant="extra"><div class="template-box-title">&nbsp;</div><div class="template-box-description">Lue <a href="https://sonat.com/@sonat/articles/top-13-rules-to-create-a-user-manual?lang=en">13 todistettua sääntöä luodaksesi käyttöoppaasi</a> helposti.</div></aside>5. Käytäntökäsikirja:Käytäntökäsikirja tai käytäntö- ja menettelykäsikirja on yleensä hyvä viite johtajille ja esimiehille auttamaan heitä päätöksenteossa ja yrityksen tehokkaassa johtamisessa. Se sisältää kaikki yrityksen ohjeet, säännöt ja käytännöt sekä tarkat menettelyt näiden käytäntöjen ja standardien noudattamiseksi.6. Organisaatiokäsikirja:Se määrittelee organisaatiorakenteen ja sisältää kaikki tiedot organisaation asemista, tehtävistä, velvollisuuksista, toimenkuvista, vastuista, suhteista ja hierarkioista. Joten se auttaa työntekijöitä tuntemaan ja suorittamaan työasemansa paremmin.&nbsp;<h2 id="oppaat">Oppaat</h2>&nbsp;Mikä nyt on opas?Verrattuna käsittelemiimme käsikirjoihin opas on yleisempi termi, joka viittaa mihin tahansa oppaisiin ja ohjeisiin. Opas ei välttämättä tarkoita tuotteen käyttöä. Käyttöoppaan ei tarvitse olla kattava, ja se voi olla yksinkertainen kuin kortti, joka antaa käyttäjille hyödyllisiä ohjeita.&nbsp;&nbsp;<aside class="template-box note-template-box" variant="note"><div class="template-box-title">&nbsp;</div><div class="template-box-description">Termejä käyttöopas, käyttöohje, käyttöopas ja käyttöopas käytetään usein vaihtokelpoisina, koska niiden ensisijaisena tavoitteena on auttaa tuotetta käyttämään oikein.</div></aside>&nbsp;<h2 id="johtop-t-s">Johtopäätös</h2>&nbsp;Organisaation dokumentointi voidaan luokitella eri tavoilla. Yksi tapa on päättää, mitkä asiakirjat jaetaan ulkopuolisille ja mitkä eivät. Yksityiskohtaisia ​​teknisiä ja yrityksen toimintaperiaatteita ja menettelytapoja ei ole tarkoitus jakaa ulkopuolisille. Toisaalta järjestelmä- ja käyttäjädokumentaatio voi auttaa käyttäjiä tutustumaan yrityksen tuotteeseen tarpeen mukaan. Tarkastellaanpa siis nopeasti pääkohdat:<figure class="image"><img src="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/5d3c8c6a-39d6-4cb3-bf5a-95e41930cbdc.webp" alt="Dokumentaation luokitus" srcset="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/5d3c8c6a-39d6-4cb3-bf5a-95e41930cbdc.webp?width=320 320w, /api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/5d3c8c6a-39d6-4cb3-bf5a-95e41930cbdc.webp?width=640 640w, /api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/5d3c8c6a-39d6-4cb3-bf5a-95e41930cbdc.webp?width=800 800w" sizes="100vw" width="800"></figure>&nbsp;<figure class="table"><table><thead><tr><th colspan="4">Dokumentaatio: Muodolliset kuvailevat ja informatiiviset asiakirjat</th></tr></thead><tbody><tr><td colspan="2">Sisäinen dokumentaatio : Kohdistaa ihmisiä organisaatiossa, mukaan lukien tekninen ja toimistohenkilöstö.</td><td colspan="2">Ulkoinen/tuotedokumentaatio : kohdennetaan käyttäjille ja ulkopuolisille</td></tr><tr><td>Tekninen/prosessidokumentaatio : Sisältää projekti- ja testisuunnitelmat, suunnitelmat ja kehitystyöt, jotka jaetaan sisäisesti teknisen tiimin kanssa.</td><td>Organisaatiotukidokumentaatio: Yrityksen politiikka, menettelyt, standardit, organisaatiokaaviot ja koulutusmateriaalit.</td><td>Käyttäjädokumentaatio: Kohdistaa loppukäyttäjiä; yleisin muoto on käyttöohje.</td><td>Järjestelmän dokumentaatio: Kohdennettu kokeneille käyttäjille (insinöörit ja huoltohenkilöstö)</td></tr></tbody></table></figure>Käyttäjädokumentaatio koostuu pääasiassa seuraavista:<ul><li>Käyttöopas</li><li>Asennusohje</li><li>Vianmääritysopas</li><li>Ohjekirja</li></ul>Käyttäjädokumentoinnin tavoite on:Auta käyttäjiä oppimaan tuotteesta ja miten:<ul><li>Asentaa</li><li>Toimi</li><li>Vianetsintä</li><li>Pidä käyttäjät poissa mahdollisista vaaroista</li></ul>Tekninen dokumentaatio kattaa pääasiassa:<ul><li>Testaussuunnitelmat</li><li>Tekninen suunnitteluspesifikaatio</li><li>Projektisuunnitelmat</li></ul>Teknisen dokumentoinnin tavoite on:Pidä kirjaa organisaation teknisestä prosessista ja perehdyttämisteknikoista:<ul><li>kehitystä</li><li>Testaus</li><li>Huolto</li><li>Parantaminen</li></ul><aside class="template-box extra-template-box" variant="extra"><div class="template-box-title">&nbsp;</div><div class="template-box-description">100 % taattu, 100 % ilmaiset käyttöopasmallit auttavat sinua kirjoittamaan käsikirjan tyhjästä. <a href="https://editor.sonat.com/auth/signup">Kirjaudu</a>&nbsp;&nbsp; ja <a href="https://sonat.com/@sonat/articles/free-user-manual-template?lang=en">Kirjoita ammattimainen käsikirja käyttämällä ilmaisia ​​käyttöopasmalleja</a> .</div></aside>

13 parasta yksinkertaista mutta tehokasta sääntöä käyttöoppaiden luomiseen

Kirjoita ammattimainen käsikirja käyttämällä ilmaisia ​​käyttöopasmalleja

Mikä käyttöopas oikein on ja miksi se on niin tärkeä?

Kuinka luoda ammattikäyttöopas

Miksi sinun pitäisi lopettaa käyttöoppaiden kirjoittaminen Microsoft Wordilla?

Mitä on tekninen kirjoittaminen ja kuka on tekninen kirjoittaja

Mikä on paras tapa luoda käyttöoppaita?

Mikä on online-käyttöopas? Hanki vastaus täältä!

Ohjelmiston opetusohjelman kirjoittaminen: Vaiheittainen opas

Online-opetusohjelmien luoja: Kuinka luoda kiinnostavia ja tehokkaita verkko-opetusohjelmia

Vaiheittainen opetusohjelma, usein kysytyt kysymykset

Home