EXPERT – Modulo 11

L'evento è concluso

 

LIVELLO EXPERT – Modulo 11

Software Documentation


 

Modulo in lingua inglese. Per informazioni sul servizio di interpretazione simultanea contattare coordinamento@comtec-italia.org


Spesso dovendo scrivere documentazione per applicazioni software non si sa da dove iniziare.

Spesso infatti si verifica confusione sui passi da seguire e anche su come e da dove iniziare.

Il Modulo 11 mira a risolvere una serie di problematiche in fase di redazione di documentazione software e ad eliminare una serie di dubbi comuni.

 

Nello specifico questo Modulo ha lo scopo di:

  1. Descrivere i tipi di documentazione software che i comunicatori tecnici possono redigere e realizzare
  2. Spiegare il processo di preparazione, organizzazione e distribuzione di documentazione software per utilizzatori di prodotti software
  3. Chiarire il ruolo del redattore tecnico in un team di sviluppatori software e il valore che un redattore tecnico rappresenta per il team
  4. Creare immagini, grafiche e infografiche di tipo istruzionale che sono richieste nella documentazione software utilizzando dei template predefiniti e progettati in maniera professionale
  5. Favorire una migliore comprensione e una migliore pratica su come redigere documentazione software in un GitHub wiki utilizzando il linguaggio del Markdown markup e la redazione strutturata seguendo i template di redazione tecnica del formatore.
  6. Facilitare una comprensione e una pratica di base su come scrivere per gli sviluppatori, redigendo documentazione API con l’uso di Swagger UI.

 


 

Do you have to write documentation about software applications, but you just do not know where to get started? Do you feel confused about the steps you need to take or even where and how to get started?

If yes, this course can help!

 

By the end of this course:

  1. You will be able to describe the types of software documentation you can write.
  2. You will be able to explain the process for preparing, organizing, and delivering software documentation for the users of software products.
  3. You will have clarity about the role of the technical writer in the team of software developers and what value you bring to the team.
  4. You will be able to create instructional images, graphics, or infographics needed in your documentation using predefined professionally designed templates.
  5. You have a basic understanding and practice of how to write software documentation in a GitHub wiki using Markdown markup language and structured writing following the instructor’s templates for writing.
  6. You have a basic understanding and practice of how to write for developers, writing API documentation using Swagger UI.

 

Il Modulo 11 comprende 3 sessioni formative e 1 esercitazione nelle date e orari seguenti:

  • 10/05/22 ore 16:00 ÷ 18:30
  • 12/05/22 ore 16:00 ÷ 18:30
  • 17/05/22 ore 16:00 ÷ 18:30
  • 19/05/22 ore 16:00 ÷ 18:00 – Ambito Redazione

 

Vedi sotto per il dettaglio delle singole Sessioni.

  • Jordan Stanchev
Sessione Formativa
16:00 ÷ 18:30
User Assistance Development Architect in SAP
  • Jordan Stanchev
Sessione Formativa
16:00 ÷ 18:30
User Assistance Development Architect in SAP
  • Jordan Stanchev
Sessione Formativa
16:00 ÷ 18:30
User Assistance Development Architect in SAP
  • Jordan Stanchev
Sessione di Esercitazione Redazione
16:00 ÷ 18:00
User Assistance Development Architect in SAP
Jordan Stanchev

Jordan Stanchev

User Assistance Development Architect in SAP

Dettaglio Modulo

10 Maggio 2022 16:00
19 Maggio 2022 18:00
Online

Extra Info

Modulo in lingua inglese.
Per informazioni sul servizio di interpretazione simultanea contattare coordinamento@comtec-italia.org