Sonat

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

Articles

V1.0.0

Intern, ekstern, produkt-, proces-, teknisk- og brugerdokumentation

<h1>Intern, ekstern, produkt-, proces-, teknisk- og brugerdokumentation</h1>Har du altid haft brug for en afklaring med mange begreber, der refererer til forskellige former for dokumentation? Tag et kig på følgende spørgsmål.Hvad betyder manual og brugerdokumentation? Hvad er en brugermanual? Betragtes det at skrive en brugervejledning som teknisk dokumentation? Hvad er forskellene mellem en træningsmanual og en instruktionsmanual? Ekstern og intern dokumentation? Produkt- og procesdokumentation?Her vil vi klassificere og definere alle disse relaterede termer på en måde, der giver mest mening, så du lærer, hvordan de ligner eller er forskellige. Dokumentationsbegreber kan dog bruges i flæng; Vi dækker dem også. Så lad os starte med at definere det mest generelle udtryk i dette emne:<aside class="template-box extra-template-box" variant="extra"><div class="template-box-title">&nbsp;</div><div class="template-box-description">Få flere oplysninger om <a href="https://sonat.com/@sonat/articles/what-exactly-is-a-user-manual-and-why-is-it-so-important-?lang=en">vigtigheden af ​​en brugervejledning</a> for din virksomhed.</div></aside>&nbsp;<h2 id="dokumentation">Dokumentation</h2>&nbsp;Dokumentation er overførbart materiale, der formelt giver information til introduktion, beskrivelse, træning og instruktion vedrørende et system, produkt, service, organisation, procedure eller teknisk proces. I mange tilfælde er disse formelle og informative dokumenter også kendt som manualer.Lad os gå til næste niveau.Når man diskuterer et produkt eller en service, kan en god klassificering opdele dokumentation eller manualer i to hovedgrupper; Teknisk dokumentation og brugerdokumentation . En anden kategori kan opdele dokumenter i produktdokumentation og procesdokumentation, svarende til den første kategori. En anden rimelig metode til at klassificere dokumentation, især vedrørende organisatoriske indstillinger, er at organisere dokumentation baseret på at være intern eller ekstern.Vi diskuterer dem alle og starter med den bredeste.<h3>Ekstern dokumentation <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="Ekstern dokumentation" 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>Som du kan gætte ud fra navnet, er ekstern dokumentation beregnet til at blive delt med personer uden for en organisation (virksomhed, forretningsenhed osv.) for at give information og vejledninger vedrørende et produkt eller en tjeneste. Derfor kunne ekstern dokumentation også kaldes Produktdokumentation. En virksomheds eksterne/produktdokumentation kunne opdeles i Brugerdokumentation og Systemdokumentation .<h4 style="text-align:justify;">A. Brugerdokumentation</h4>Brugerdokumentation, også kendt som slutbrugerdokumentation, retter sig mod slutbrugere for at give omfattende information om et produkt eller en tjeneste. Dokumenter i denne gruppe kan også kaldes Brugerassistance. Deres primære formål er at hjælpe brugerne med nyttige oplysninger om et produkt, såsom en generel introduktion, beskrivelse af dets funktioner og instruktioner om installation, brug og vedligeholdelse af det.Manualer i denne gruppe underviser i fag med en teknisk forklaring. Alligevel, da målet er slutbrugere, skal de begrænse detaljerede tekniske oplysninger og bruge et simpelt sprog med standardudtryk og -udtryk i stedet for teknisk jargon. Derfor giver de brugervenlige vejledninger og trin-for-trin instruktioner til praktisk brug. Derfor, selvom brugerdokumentation er i en <a href="https://sonat.com/@sonat/articles/who-is-a-technical-writer?lang=en">teknisk forfatters</a> område (en, der bruger den tekniske information, forstår den og oversætter den til kortere og enklere indhold for slutbrugerne), betragtes den ikke altid som teknisk dokumentation. Da de normalt ikke er målrettet mod eksperter og professionelle mennesker. Vi vil diskutere teknisk dokumentation senere i denne artikel.<aside class="template-box extra-template-box" variant="extra"><div class="template-box-title">&nbsp;</div><div class="template-box-description">Overraskende enkel måde at oprette din brugermanual med <a href="https://sonat.com/features/">Sonats gratis brugermanualskabeloner</a> .</div></aside>Lad os gennemgå forskellige former for brugerdokumentation:<ul><li>Installations- og opsætningsmanual<ul><li>Installations- og opsætningsmanualen indeholder detaljerede oplysninger om installation, opsætning og start af et produkt.</li></ul></li><li>Instruktionsmanual<ul><li>En manual, der instruerer brugerne i, hvordan produktet skal bruges korrekt.</li></ul></li><li>Fejlfindingsmanual<ul><li>En manual, der omhandler, hvordan man løser almindelige problemer med produktet.</li></ul></li><li>Brugermanual<ul><li>En typisk brugervejledning indeholder ofte alle de ovennævnte vejledninger på ét sted. Brugermanualer fokuserer på forskellige brugere, herunder faglærte og ufaglærte, og giver instruktioner om produktets opsætning, drift og vedligeholdelse. De introducerer produktet til brugerne og skitserer dets standardfunktionalitet og dets forskellige funktioner og applikationer. De omfatter normalt forholdsregler vedrørende brug af produktet og kan også omfatte grundlæggende ofte stillede spørgsmål og fejlfinding.</li></ul></li></ul>&nbsp;<h4 style="text-align:justify;">B. Systemdokumentation <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="System dokumentation" 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>Systemdokumentation kan komme som en servicemanual eller en reparationsmanual . Systemdokumentation omfatter en oversigt over de underliggende systemer, mere detaljerede tekniske oplysninger og reparationsinstruktioner til at hjælpe mekanikere, ingeniører og andre avancerede brugere med at reparere produktet.<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;">Intern dokumentation</h3>Intern dokumentation er ikke beregnet til at blive delt eksternt. Det omfatter tekniske detaljer og organisatoriske politikker, procedurer osv., som er unødvendige eller produktive for brugerne. Generelt fungerer dokumenter i denne gruppe som en reference for medarbejdere, tekniske teams, ledere eller andre kontormedarbejdere for at få deres arbejde udført mere effektivt. Som nævnt ovenfor kan intern dokumentation opdeles i Teknisk/Procesdokumentation og Organisationsstøttedokumentation .&nbsp;<h4 style="text-align:justify;">A. Teknisk dokumentation</h4>Når vi bruger udtrykket <a href="https://sonat.com/@sonat/articles/who-is-a-technical-writer?lang=en">teknisk dokumentation</a> , mener vi de interne dokumenter, der hovedsageligt distribueres blandt det tekniske team i en organisation. De dækker emner som testplaner, udviklingsprocesser, designspecifikationer, projektplaner, vedligeholdelse og forbedring af systemet osv. og mange fagudtryk. Udtrykket procesdokumentation refererer næsten til den samme slags dokumenter. Teknisk dokumentation og procesdokumentation kan bruges i flæng.&nbsp;<h4 style="text-align:justify;">B. Organisation-Support dokumentation</h4>I enhver organisation er der forskellige manualer og dokumentation til træning af medarbejdere og definition af interne organisatoriske retningslinjer, og de fleste af disse dokumenter er inden <a href="https://resources.workable.com/hr-manager-job-description">for HR-området</a> . Lad os diskutere nogle af de mest almindelige manual-relaterede termer, du støder på i en organisation:1. Betjeningsvejledning:Denne manual indeholder standarder og retningslinjer for en virksomhed, der beskriver, hvad og hvordan der skal gøres. Derfor hjælper det personalet med at udføre deres arbejde mere korrekt og effektivt, især hvad angår kvaliteten og sikkerheden af ​​varer og tjenester.2. Krisehåndteringsmanual:Det er en manual til at instruere medarbejdere i, hvordan de skal reagere på kriser på arbejdspladsen.3. Revisionsmanual:Den beskriver en virksomheds revisionspolitikker og -procedurer.4. Træningsmanual:En træningsmanual er primært designet til at forbedre udførte opgaver og kunne omfatte instruktion til træning af medarbejdere. Træningsmanualer kan bruges som referencevejledninger for både begyndere og bekendte/erfarne medarbejdere.<aside class="template-box extra-template-box" variant="extra"><div class="template-box-title">&nbsp;</div><div class="template-box-description">Læs <a href="https://sonat.com/@sonat/articles/top-13-rules-to-create-a-user-manual?lang=en">13 gennemprøvede regler for nemt at oprette din brugermanual</a> .</div></aside>5. Politikhåndbog:En politikmanual eller en politik- og proceduremanual er normalt en god reference for ledere og tilsynsførende til at hjælpe dem med at træffe beslutninger og drive virksomheden effektivt. Den indeholder alle virksomhedens retningslinjer, regler og politikker samt de nøjagtige procedurer for at følge disse politikker og standarder.6. Organisationsmanual:Den definerer organisationsstrukturen og inkluderer alle oplysninger om en organisations positioner, opgaver, pligter, jobbeskrivelser, ansvar, relationer og hierarkier. Så det hjælper medarbejderne til at kende og udføre deres job bedre.&nbsp;<h2 id="vejledninger">Vejledninger</h2>&nbsp;Hvad er nu en guide?Sammenlignet med de manuelle termer, vi diskuterede, er en guide en mere generel term, der henviser til enhver manual med guider og hjælp. En guide handler ikke nødvendigvis om at bruge et produkt. En brugervejledning behøver ikke at være omfattende og kunne være så enkel som et kort, der giver brugerne nogle nyttige instruktioner.&nbsp;&nbsp;<aside class="template-box note-template-box" variant="note"><div class="template-box-title">&nbsp;</div><div class="template-box-description">Begreberne brugervejledning, brugervejledning, brugervejledning og brugermanual bruges ofte i flæng, da deres primære mål er at hjælpe med at bruge et produkt korrekt.</div></aside>&nbsp;<h2 id="konklusion">Konklusion</h2>&nbsp;Dokumentation af en organisation kan kategoriseres i forskellige metoder. En metode er at beslutte, hvilke dokumenter der skal deles eksternt, og hvilke der ikke er. Detaljerede tekniske og virksomhedspolitikker og -procedurer er ikke beregnet til at blive distribueret blandt udenforstående. På den anden side kan system- og brugerdokumentation hjælpe brugerne med at lære om en virksomheds produkt efter behov. Så lad os få en hurtig gennemgang af hovedpunkterne:<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="Dokumentationsklassificering" 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">Dokumentation: De formelle beskrivende-informative dokumenter</th></tr></thead><tbody><tr><td colspan="2">Intern dokumentation : Målretter mod personer i en organisation, herunder teknisk personale og kontorpersonale.</td><td colspan="2">Ekstern/Produktdokumentation : retter sig mod brugere og udenforstående</td></tr><tr><td>Teknisk/Procesdokumentation : Indeholder projekt- og testplaner, design og udvikling, der deles internt med det tekniske team.</td><td>Organisationsstøttedokumentation: Politik, procedurer, standarder, organisationsdiagrammer og træningsmaterialer for en virksomhed.</td><td>Brugerdokumentation: Målretter mod slutbrugere; den mest almindelige form er en brugermanual.</td><td>Systemdokumentation: Målretter mod avancerede brugere (ingeniører og vedligeholdelsespersonale)</td></tr></tbody></table></figure>Brugerdokumentation består hovedsageligt af følgende:<ul><li>Instruktionsmanual</li><li>Installationsmanual</li><li>Fejlfindingsmanual</li><li>Brugermanual</li></ul>Mål med brugerdokumentation er:Hjælp brugerne med at lære om et produkt, og hvordan man:<ul><li>Installere</li><li>Betjene</li><li>Fejlfinding</li><li>Hold brugerne væk fra mulig fare</li></ul>Teknisk dokumentation dækker hovedsageligt:<ul><li>Testplaner</li><li>Teknisk designspecifikation</li><li>Projektplaner</li></ul>Målet med teknisk dokumentation er:Før registre over den tekniske proces og onboarding-teknikere i en organisation for:<ul><li>udvikling</li><li>Afprøvning</li><li>Vedligeholdelse</li><li>Forbedring</li></ul><aside class="template-box extra-template-box" variant="extra"><div class="template-box-title">&nbsp;</div><div class="template-box-description">100 % garanteret, 100 % gratis brugermanualskabeloner hjælper dig med at skrive din manual fra bunden. <a href="https://editor.sonat.com/auth/signup">Tilmelde</a>&nbsp;&nbsp; og <a href="https://sonat.com/@sonat/articles/free-user-manual-template?lang=en">Skriv en professionel manual ved hjælp af gratis brugermanualskabeloner</a> .</div></aside>

Top 13 enkle men kraftfulde regler for oprettelse af brugervejledninger

Skriv en professionel manual ved hjælp af gratis brugermanualskabeloner

Hvad er en brugermanual helt præcist, og hvorfor er den så vigtig?

Sådan opretter du en professionel brugermanual

Hvorfor du skal stoppe med at skrive brugervejledninger med Microsoft Word

Hvad er teknisk skrivning, og hvem er teknisk skribent

Hvad er den bedste tilgang til at lave brugermanualer?

Hvad er en onlinebrugervejledning? Få svaret her!

Sådan skriver du en vejledning til din software: En trin-for-trin guide

Online tutorial Creator: Sådan opretter du engagerende og effektive online tutorials

Trin for trin vejledning, ofte stillede spørgsmål

Home