CURS LIVE ONLINE

Documentație Tehnică în IT

Rodica Buga  Senior Technical Writer @ VIAVI Solutions

DESPRE CURS

DATA:

4 Martie - 20 Aprilie

DURATA:

14 lecții
7 săptămâni
Luni & Miercuri, ora 19:00 - 20:30

Dobândește competențele necesare pentru a crea și menține documentație IT orientată pe proces, utilă în echipe software și pentru avansarea în carieră. Învață să planifici, să structurezi și să actualizezi documente care urmăresc corect evoluția produsului, adaptate pentru end-user, dezvoltator, QA și stakeholder.

Cursul pune accent pe standardizare, colaborare în Agile/DevOps și utilizarea instrumentelor din industrie (Markdown, Google Docs, GitHub, style guides, versioning).

Cursul ideal pentru tine dacă ești:

  • QA Tester

    Documentează structurat și clar procesele tehnice

  • Software Developer

    Modifică documentația dintr-o sarcină confuză și consumatoare de timp într-un output clar, structurat și reutilizabil.

  • IT Project Manager

    Transformă documentația dintr-o sursă de blocaj și confuzie într-un proces standardizat, predictibil și integrat în Agile/DevOps.

  • Junior Technical Writing

    Învață să treci de la documentație neclară și nestructurată la livrarea de documentație tehnică consecventă, bine organizată și aliniată standardelor industriei.

  1. Transformă informația tehnică complexă

    Înveți să analizezi publicul, să structurezi informația logic și să redactezi ghiduri, instrucțiuni, API docs și materiale de suport adaptate diferitelor audiențe (utilizatori finali, dezvoltatori, manageri), astfel încât documentația să fie ușor de înțeles și aplicat.

  2. Creează documentație profesională

    Dobândești un proces clar de scriere tehnică: organizare, consistență terminologică, ghiduri de stil, peer review și versionare, pentru a livra documentație coerentă, actualizată și aliniată practicilor din Agile/DevOps.

  3. Lucrează cu instrumentele și practicile reale

    Înveți să folosești Markdown, GitHub, platforme CMS, formate structurate și AI ca suport de lucru, construind un portofoliu complet de documentație IT (user guides, API docs, README-uri, KB articles) gata de prezentat angajatorilor.

LECTOR

Rodica Buga

  • Senior Technical Writer la VIAVI Solutions
  • Technical writer cu peste 20 de ani de experiență dovedită la companii multinaționale.
  • Expertiză în Web authoring, documentație pentru utilizatori, CSS, SEO, și documentație pentru software-uri.
  • A realizat documentatie de API si migrari de platforme de documentatie, obtinand expertiză în rezolvarea celor mai tehnice sarcini de documentație tehnica
  • Experiență în comunicarea multi-culturala și cu diferite niveluri de expertiză tehnică și managerială (programatori, ingineri, product manageri, UX designeri)

Program

01

Introducerea în scrierea tehnică pentru IT

  • Rolul și importanța scrierii tehnice în industria IT
  • Tipuri de documentație utilizate în domeniul tehnic
  • Cum contribuie documentația la comunicarea între echipele tehnice și non-tehnice
  • Diferența dintre documentația orientată spre utilizator și cea orientată spre dezvoltator
  • Exemple de bune practici în comunicarea tehnică
02

Publicul țintă, planificarea și scopul documentației

  • Identificarea și analiza publicului (end-user, dezvoltator, QA, stakeholder)
  • Adaptarea tonului, limbajului și detaliilor în funcție de cititor
  • Cum se planifică un proiect de documentație (scop, obiective, livrabile, formate)
  • Crearea profilurilor de utilizator pentru documentație
  • Cum colectezi informații prin interviuri și cercetare preliminară cu experții tehnici
03

Structura și organizarea informației

  • Principii de structurare a conținutului tehnic
  • Cum se construiește un cuprins logic și clar
  • Ordinea informației: de la general la specific
  • Folosirea titlurilor, subtitlurilor și numerotării eficiente
  • Exemple de structuri comune pentru documente IT (ghiduri, API docs, release notes)
04

Scrierea instrucțiunilor și procedurilor

  • Cum redactezi pași clari și logici într-un ghid tehnic
  • Limbajul imperativ și claritatea în formulare
  • Greșeli frecvente în scrierea instrucțională
  • Cum se testează un ghid scris pe un utilizator real
  • Integrarea feedback-ului pentru îmbunătățirea clarității
05

Standardizare, design și consistență în documentație

  • Rolul ghidurilor de stil (style guides) în scrierea tehnică
  • Terminologie consecventă și vocabular tehnic uniform
  • Cum se creează un mini ghid de stil intern
  • Principii de design vizual: tipografie, spațiere, layout și ierarhie vizuală în documente
  • Integrarea graficelor, tabelelor și diagramelor pentru lizibilitate și claritate
06

Instrumente de lucru pentru scriere tehnică

  • Folosirea Markdown pentru formatarea documentației
  • Lucrul colaborativ în Google Docs
  • Noțiuni de bază despre controlul versiunilor cu GitHub
  • Integrarea documentației în proiecte software
  • Introducere în platforme CMS pentru documentație (Confluence, GitBook, Docusaurus)
  • Paradigme de authoring în technical writing (scriere structurată și nestructurată)
  • Documentația ca și cod (Docs as Code)
  • Introducere în limbaje și formate pentru scriere structurată (XML, DITA, DocBook)
07

Colaborarea între scriitorii tehnici și echipele IT

  • Rolurile echipelor în procesul de documentare
  • Cum comunici eficient cu dezvoltatori, testeri și manageri de proiect
  • Gestionarea feedback-ului tehnic și editorial
  • Colaborarea prin sistemul de versionare (Git workflow)
  • Documentarea proceselor Agile și DevOps: cum menții actualizată documentația în sprinturi
08

Documentația pentru utilizatori finali

  • Crearea manualelor de utilizare pas cu pas
  • Integrarea capturilor de ecran și elementelor vizuale
  • Redactarea secțiunilor de întrebări frecvente (FAQ)
  • Scrierea secțiunilor de depanare (troubleshooting)
  • Adaptarea conținutului pentru accesibilitate (WCAG, limbaj clar, contrast vizual)
09

Documentația pentru dezvoltatori (API, cod, arhitectură)

  • Cum documentezi un API (endpointuri, parametri, exemple)
  • Scrierea unui README profesional pentru proiecte software
  • Crearea descrierilor de arhitectură și componente de sistem
  • Exemple de documentație API în format Markdown
  • Documentația pentru servicii Cloud și SaaS (exemple: AWS, Azure, GCP)
10

Ghiduri de instalare și configurare

  • Cum structurezi un ghid de instalare complet
  • Introducerea comenzilor, scripturilor și configurărilor pas cu pas
  • Scrierea pentru utilizatori cu diferite niveluri tehnice
  • Utilizarea capturilor de ecran și exemplelor de cod
  • Testarea instrucțiunilor pe un sistem real
11

Ghiduri de depanare (troubleshooting) și mentenanță

  • Identificarea problemelor frecvente și soluțiile aferente
  • Scrierea logică a pașilor de rezolvare
  • Cum documentezi mesaje de eroare și remedieri
  • Organizarea problemelor după cauze sau simptome
  • Introducere în localizare și traducerea documentației pentru audiențe internaționale
12

Revizuirea și publicarea documentației

  • Cum se realizează procesul de peer review în echipă
  • Verificarea acurateței tehnice și a coerenței limbajului
  • Pregătirea documentației pentru publicare (online/offline)
  • Gestionarea versiunilor și actualizărilor periodice
  • Etică, confidențialitate și principii SEO pentru documentația publicată online
13

Inteligență artificială și documentație asistată de AI

  • Cum se folosește AI pentru crearea de drafturi, corecturi, exemple
  • Cum se verifică acuratețea tehnică a conținutului generat automat
  • Exemple de prompturi eficiente pentru documentație IT
  • Limitările instrumentelor AI în scrierea tehnică: erori, bias și lipsa de context tehnic
  • Documentație pentru tehnologii emergente (VR, AR, Emerging Tech Platforms)
14

Proiect final și portofoliu profesional

  • Construirea și prezentarea unui pachet complet de documentație IT
  • Cum să prezinți documentația unui potențial angajator
  • Cum să structurezi un portofoliu digital (GitHub Pages, Notion, LinkedIn)
  • Plan personal de dezvoltare pentru cariera în scriere tehnică

Înscrie-te la curs

Completează formularul de înscriere pentru a primi mai multe detalii despre curs și taxa de participare.

Câmp obligatoriu
Află prețul