icon icon

Kurs Tworzenie dokumentacji technicznej zgodnej ze standardem S1000D

icon

Proces szkoleniowy

Analiza potrzeb szkoleniowych

Jeśli masz życzenie dotyczące programu szkolenia, przeprowadzimy dla Ciebie analizę potrzeb szkoleniowych, która będzie wskazówką dla nas, na jakie aspekty programu położyć większy nacisk – tak, by program szkolenia spełniał konkretne potrzeby.

Co zyskujesz?

icon

Modułowe myślenie o dokumentacji - Nauczysz się zamieniać tradycyjne dokumenty na moduły danych S1000D, dzięki czemu łatwiej przygotujesz spójną dokumentację techniczną, serwisową i eksploatacyjną.

icon

Swoboda pracy z CSDB - Zrozumiesz, jak działa CSDB, DMRL i wersjonowanie dokumentów, więc sprawniej odnajdziesz, zatwierdzisz i ponownie wykorzystasz treści w wielu publikacjach bez chaosu.

icon

Pewność w pracy z XML - Opanujesz strukturę XML stosowaną w S1000D, poznasz schematy i walidację, dzięki czemu szybciej wykryjesz błędy i przygotujesz dokumenty poprawne formalnie.

icon

Lepsze opisy procedur - Dowiesz się, jak pisać instrukcje obsługi, konserwacji i napraw w sposób zgodny ze standardem, tak aby użytkownik końcowy mógł łatwo wykonać zadanie krok po kroku.

icon

Spójność terminów i danych - Poznasz zasady języka kontrolowanego, nazewnictwa i reguł BREX, więc ograniczysz niespójności między modułami oraz ułatwisz współpracę autorów, recenzentów i wydawców.

icon

Gotowość do publikacji - Nauczysz się przygotowywać treści do publikacji w PDF, HTML oraz IETP/IETM, dzięki czemu łatwiej dopasujesz formę dokumentacji do potrzeb użytkownika i kanału dystrybucji.

icon

Świadomy dobór narzędzi - Poznasz rolę edytorów XML, systemów CSDB oraz narzędzi do walidacji i publikacji, co pomoże Ci dobrać rozwiązania pasujące do procesu dokumentacyjnego w organizacji.

icon

Praktyka na realnym przykładzie - Podczas warsztatu przećwiczysz analizę dokumentacji, utworzenie prostego modułu danych i sprawdzenie zgodności z S1000D, więc wyjdziesz z gotowym schematem działania.

Program szkolenia

1. Wprowadzenie do standardu S1000D

  • czym jest S1000D i gdzie jest stosowany,
  • rola standardu w dokumentacji technicznej, serwisowej i eksploatacyjnej,
  • dokumentacja modułowa a tradycyjna dokumentacja techniczna,
  • korzyści z wdrożenia S1000D w organizacji.

2. Struktura dokumentacji w S1000D

  • podstawowe pojęcia: Data Module, CSDB, DMRL, BREX, SNS,
  • budowa modułu danych,
  • zasady identyfikacji i kodowania dokumentacji,
  • typy modułów danych i ich zastosowanie.

3. Tworzenie treści technicznych zgodnych ze standardem

  • zasady opisu procedur technicznych,
  • tworzenie instrukcji obsługi, konserwacji i napraw,
  • opisywanie części, komponentów i systemów,
  • stosowanie języka kontrolowanego i spójnej terminologii.

4. Praca z XML w dokumentacji S1000D

  • podstawy struktury XML,
  • znaczniki i schematy wykorzystywane w S1000D,
  • walidacja poprawności dokumentacji,
  • typowe błędy w dokumentach XML.

5. Zarządzanie dokumentacją w CSDB

  • czym jest Common Source Database,
  • wersjonowanie i statusy dokumentów,
  • obieg zatwierdzania dokumentacji,
  • ponowne wykorzystanie treści w wielu publikacjach.

6. Reguły biznesowe i jakość dokumentacji

  • BREX jako zestaw reguł biznesowych,
  • kontrola zgodności dokumentacji ze standardem,
  • spójność danych, nazewnictwa i struktury,
  • audyt i utrzymanie jakości dokumentacji technicznej.

7. Publikowanie dokumentacji technicznej

  • przygotowanie dokumentacji do publikacji,
  • publikacje PDF, HTML, IETP/IETM,
  • zarządzanie aktualizacjami,
  • dystrybucja dokumentacji do użytkowników końcowych.

8. Narzędzia wspierające pracę ze standardem S1000D

  • edytory XML,
  • systemy CSDB,
  • narzędzia do walidacji i publikacji,
  • integracja z systemami PLM, ERP i ILS.

9. Wdrożenie S1000D w organizacji

  • analiza obecnego sposobu tworzenia dokumentacji,
  • przygotowanie struktury danych i zasad pracy,
  • role w procesie dokumentacyjnym,
  • dobre praktyki wdrożeniowe.

10. Warsztat praktyczny

  • analiza przykładowej dokumentacji technicznej,
  • przygotowanie prostego modułu danych,
  • sprawdzenie zgodności dokumentu z założeniami S1000D,
  • omówienie typowych problemów i sposobów ich rozwiązania.

Jakie są wymagania wstępne do udziału w szkoleniu?

icon

Podstawy dokumentacji technicznej - Powinieneś rozumieć, jak są budowane instrukcje, opisy procedur i dokumenty serwisowe, aby łatwo przejść od klasycznej dokumentacji do podejścia modułowego.

icon

Znajomość procesów technicznych - Powinieneś orientować się w podstawowych procesach obsługi, konserwacji lub napraw, bo szkolenie zakłada pracę na przykładach procedur i treści technicznych.

icon

Podstawy pracy z komputerem - Powinieneś swobodnie pracować z plikami, strukturą folderów i aplikacjami biurowymi, ponieważ podczas szkolenia będziesz analizować i przygotowywać dokumentację cyfrową.

icon

Podstawy języka angielskiego technicznego - Powinieneś rozumieć podstawowe terminy techniczne po angielsku, ponieważ nazwy pojęć S1000D, elementów XML i narzędzi często występują właśnie w tym języku.