Kod: REQ-028
Czas trwania: 16 godzin
Czas trwania: 16 godzin
Opis szkolenia
Szkolenie obejmuje całość zunifikowanego procesu tworzenia dokumentacji użytkownika końcowego - od określenia jej struktury, poprzez weryfikację i publikację.W szkoleniu omówione są szczegółowo różne kwestie dotyczące korekty, formułowania i formatowania tekstu. Podczas szkolenia uczestnicy będę mieć możliwość przeanalizować i poprawić liczne przykłady niepoprawnych sformułowań z różnych źródeł.
Pisanie dokumentów technicznych (takich jak specyfikacje, wymagania itp.) nie stanowi nieodłącznego elementu w pracy autorów dokumentów technicznych, jednak powinni oni rozumieć zasady tworzenia takich dokumentów i posiadać umiejętność wyboru informacji niezbędnych do opracowania dokumentacji dla użytkownika końcowego. Dlatego też kurs ten skupia się również na jednej z form opisu wymagań - przypadkach użycia, które można przekształcić w szczegółowe instrukcje dla użytkowników.
Plan szkolenia
• Jakość dokumentacjio Zadania autora dokumentów technicznych
o Wymagania dla dokumentacji
• Etapy tworzenia dokumentacji i rodzaje pracy
o Tworzenie dokumentacji jako element projektu rozwojowego oprogramowania
o Etapy opracowywania dokumentacji
o Zlecenie opracowania dokumentacji
• Rodzaje i struktura dokumentów
o Rodzaje dokumentów technicznych
o Forma i struktura dokumentu, rodzaje informacji
o Przypadki użycia
o Opracowywanie części funkcjonalnej dokumentu
o Opracowywanie części dokumentu z odwołaniami i opisami
o Rozdziały uporządkowane według struktury
• Opracowanie i układ tekstu
o Podstawowe zasady prezentacji informacji
o Przykłady treści o niskiej jakości
o Zasady formatowania tekstu, dyscyplina stylistyczna
o Weryfikacja dokumentów
• Narzędzia i zasoby dla autorów dokumentów technicznych
o Zalecenia dotyczące korzystania z programu MS Word
o Dodatkowe zasoby internetowe i przydatne narzędzia
Cele
- Nauczyć się w jaki sposób definiować wymagania dla dokumentacji i je stosować,
- prawidłowo prezentować informacje
- stosować zasady porządkowania i formatowania dokumentacji
- identyfikować i poprawiać typowe błędy w dokumentacji technicznej
- stosować zaawansowane narzędzia do formatowania tekstu (MS Word)
Grupa docelowa
Kurs przeznaczony jest dla autorów dokumentów technicznych, w tym osób początkującychWymagania
- Ogólna wiedza na temat procesów tworzenia oprogramowania
- Doświadczenie w korzystaniu z edytorów tekstu i innych programów do edycji tekstu