Dokumentacja wewnętrzna, zewnętrzna, produktowa, procesowa, techniczna i użytkownika

Czy zawsze potrzebowałeś wyjaśnień w przypadku wielu terminów odnoszących się do różnych rodzajów dokumentacji? Przyjrzyj się poniższym pytaniom.

Co oznacza instrukcja i dokumentacja użytkownika? Co to jest instrukcja obsługi? Czy napisanie instrukcji obsługi jest dokumentacją techniczną? Jakie są różnice pomiędzy instrukcją szkoleniową a instrukcją obsługi? Dokumentacja zewnętrzna i wewnętrzna? Dokumentacja produktu i procesu?

Tutaj sklasyfikowamy i zdefiniujemy wszystkie powiązane terminy w sposób, który będzie jak najbardziej sensowny, dzięki czemu dowiesz się, jakie są między nimi podobieństwa, a jakie różnice. Jednakże terminy związane z dokumentacją mogą być używane zamiennie; Zajmiemy się nimi także. Zacznijmy więc od zdefiniowania najbardziej ogólnego terminu w tym temacie:

Dokumentacja

Dokumentacja to materiał przekazywany, który formalnie dostarcza informacji do wprowadzenia, opisu, szkolenia i instrukcji dotyczących systemu, produktu, usługi, organizacji, procedury lub procesu technicznego. W wielu przypadkach te dokumenty formalne i informacyjne nazywane są także podręcznikami.

Przejdźmy na następny poziom.

Omawiając produkt lub usługę, dobra klasyfikacja może podzielić dokumentację lub podręczniki na dwie główne grupy; Dokumentacja techniczna i dokumentacja użytkownika . Inna kategoria może dzielić dokumenty na Dokumentację Produktu i Dokumentację Procesu, podobnie jak pierwsza kategoria. Inną rozsądną metodą klasyfikacji dokumentacji, zwłaszcza dotyczącej ustawień organizacyjnych, jest organizowanie dokumentacji w oparciu o to, czy jest ona wewnętrzna , czy zewnętrzna.

Omówimy je wszystkie i zaczniemy od najszerszego.

Dokumentacja zewnętrzna

Jak można się domyślić z nazwy, dokumentacja zewnętrzna przeznaczona jest do udostępniania osobom spoza organizacji (firmy, jednostki biznesowej itp.) w celu dostarczenia informacji i wskazówek dotyczących produktu lub usługi. Dlatego też dokumentację zewnętrzną można nazwać także Dokumentacją Produktu. Dokumentację zewnętrzną/produktową firmy można podzielić na Dokumentację użytkownika i Dokumentację systemu .

A. Dokumentacja użytkownika

Dokumentacja użytkownika, znana również jako dokumentacja użytkownika końcowego, jest przeznaczona dla użytkowników końcowych w celu zapewnienia kompleksowych informacji o produkcie lub usłudze. Dokumenty z tej grupy mogą być również nazywane Pomocą Użytkownika. Ich głównym celem jest dostarczenie użytkownikom przydatnych informacji o produkcie, takich jak ogólne wprowadzenie, opis jego funkcji oraz instrukcje dotyczące jego instalacji, użytkowania i konserwacji.

Podręczniki z tej grupy uczą przedmiotów za pomocą wyjaśnień technicznych. Ponieważ jednak celem są użytkownicy końcowi, muszą oni ograniczać szczegółowe informacje techniczne i używać prostego języka zawierającego standardowe terminy i wyrażenia zamiast technicznego żargonu. Dlatego udostępniają przyjazne dla użytkownika przewodniki i instrukcje krok po kroku dotyczące praktycznego zastosowania. W związku z tym, chociaż dokumentacja użytkownika jest domeną autora technicznego (tego, który wykorzystuje informacje techniczne, rozumie je i tłumaczy na krótszą i prostszą treść dla użytkowników końcowych), nie zawsze jest uważana za dokumentację techniczną. Ponieważ zazwyczaj nie są one skierowane do ekspertów i profesjonalistów. Dokumentację techniczną omówimy w dalszej części tego artykułu.

Przyjrzyjmy się różnym formom dokumentacji użytkownika:

• Instrukcja instalacji i konfiguracji
  • Podręcznik instalacji i konfiguracji zawiera szczegółowe informacje na temat instalowania, konfigurowania i uruchamiania produktu.
• Instrukcja obsługi
  • Instrukcja, która instruuje użytkowników, jak prawidłowo używać produktu.
• Instrukcja rozwiązywania problemów

  • Podręcznik opisujący sposoby rozwiązywania typowych problemów z produktem.

• Instrukcja obsługi
  • Typowa instrukcja obsługi często zawiera wszystkie wymienione powyżej poradniki w jednym miejscu. Instrukcje obsługi skupiają się na różnych użytkownikach, zarówno wykwalifikowanych, jak i niewykwalifikowanych, i zawierają instrukcje dotyczące konfiguracji, obsługi i konserwacji produktu. Przedstawiają produkt użytkownikom i opisują jego standardową funkcjonalność oraz różne funkcje i zastosowania. Zwykle zawierają one środki ostrożności dotyczące korzystania z produktu, ale mogą również zawierać podstawowe często zadawane pytania (FAQ) i rozwiązywanie problemów.

B. Dokumentacja systemu

Dokumentacja systemu może mieć postać instrukcji serwisowej lub instrukcji naprawy . Dokumentacja systemu zawiera przegląd podstawowych systemów, bardziej szczegółowe informacje techniczne i instrukcje naprawy, które pomagają mechanikom, inżynierom i innym zaawansowanym użytkownikom w naprawie produktu.

Dokumentacja wewnętrzna

Dokumentacja wewnętrzna nie jest przeznaczona do udostępniania na zewnątrz. Zawiera szczegóły techniczne i politykę organizacyjną, procedury itp., które są niepotrzebne lub produktywne dla użytkowników. Ogólnie rzecz biorąc, dokumenty w tej grupie służą jako odniesienie dla pracowników, zespołów technicznych, menedżerów i innych pracowników biurowych, aby mogli wydajniej wykonywać swoją pracę. Jak wspomniano powyżej, dokumentację wewnętrzną można podzielić na dokumentację techniczną/procesową i dokumentację wspierającą organizację .

A. Dokumentacja techniczna

Kiedy używamy terminu dokumentacja techniczna , mamy na myśli dokumenty wewnętrzne rozpowszechniane głównie wśród zespołu technicznego organizacji. Obejmują takie tematy, jak plany testów, procesy rozwojowe, specyfikacje projektowe, plany projektu, konserwacja i doskonalenie systemu itp., a także wiele terminów technicznych. Termin Dokumentacja Procesu odnosi się prawie do tego samego rodzaju dokumentów. Dokumentację techniczną i procesową można stosować zamiennie.

B. Dokumentacja wspierająca organizację

W każdej organizacji istnieją różne podręczniki i dokumentacja dotycząca szkolenia pracowników i definiowania wewnętrznych wytycznych organizacyjnych, a większość z tych dokumentów dotyczy obszaru HR . Omówmy niektóre z najczęstszych terminów związanych z podręcznikami, z którymi spotykasz się w organizacji:

1. Instrukcja obsługi:

Podręcznik ten zawiera standardy i wytyczne firmy, które określają, co i jak należy zrobić. Dzięki temu pomaga pracownikom wykonywać swoją pracę bardziej poprawnie i efektywnie, szczególnie w zakresie jakości i bezpieczeństwa towarów i usług.

2. Podręcznik zarządzania kryzysowego:

Instruowanie pracowników, jak reagować na sytuacje kryzysowe w miejscu pracy, jest podręcznikiem.

3. Podręcznik audytu:

Opisuje zasady i procedury audytu firmy.

4. Podręcznik szkoleniowy:

Podręcznik szkoleniowy ma przede wszystkim na celu doskonalenie wykonywanych zadań i może zawierać instrukcje dotyczące szkolenia pracowników. Podręczniki szkoleniowe mogą służyć jako podręczniki zarówno dla początkujących, jak i znanych/doświadczonych pracowników.

5. Podręcznik zasad:

Podręcznik polityki lub podręcznik polityki i procedur jest zwykle dobrym źródłem informacji dla menedżerów i przełożonych, pomagającym im w podejmowaniu decyzji i skutecznym prowadzeniu firmy. Zawiera wszystkie wytyczne, zasady i zasady firmy, a także dokładne procedury postępowania zgodnie z tymi zasadami i standardami.

6. Podręcznik organizacyjny:

Definiuje strukturę organizacyjną i zawiera wszystkie informacje dotyczące stanowisk, zadań, obowiązków, opisów stanowisk, odpowiedzialności, relacji i hierarchii w organizacji. Pomaga więc pracownikom lepiej poznać i wykonywać swoje stanowisko pracy.

Przewodniki

Czym jest przewodnik?

W porównaniu do terminów podręcznika, które omówiliśmy, przewodnik jest terminem bardziej ogólnym i odnosi się do dowolnego podręcznika zawierającego przewodniki i pomoc. Przewodnik niekoniecznie dotyczy korzystania z produktu. Podręcznik użytkownika nie musi być obszerny i może być tak prosty jak karta zawierająca przydatne instrukcje.  

Wniosek

Dokumentację organizacji można podzielić na różne kategorie. Jedną z metod jest podjęcie decyzji, które dokumenty będą udostępniane na zewnątrz, a które nie. Szczegółowe zasady i procedury techniczne oraz firmowe nie są przeznaczone do rozpowszechniania wśród osób trzecich. Z drugiej strony dokumentacja systemu i użytkownika może pomóc użytkownikom w poznaniu produktu firmy, jeśli zajdzie taka potrzeba. Przyjrzyjmy się więc szybko głównym punktom:

Dokumentacja użytkownika składa się głównie z następujących elementów:

• Instrukcja obsługi
• Instrukcja instalacji
• Instrukcja rozwiązywania problemów
• Instrukcja obsługi

Celem dokumentacji użytkownika jest:

Pomóż użytkownikom poznać produkt i dowiedzieć się, jak:

• zainstalować
• Działać
• Rozwiązywanie problemów
• Trzymaj użytkowników z dala od możliwego niebezpieczeństwa

Dokumentacja techniczna obejmuje głównie:

• Plany testowe
• Specyfikacja projektu technicznego
• Plany projektu

Celem dokumentacji technicznej jest:

Prowadź dokumentację procesu technicznego i wdrażania techników w organizacji przez:

• rozwój
• Testowanie
• Konserwacja
• Poprawa