Livello Expert – Modulo 11

Software Documentation

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:

Descrivere i tipi di documentazione software che i comunicatori tecnici possono redigere e realizzare
Spiegare il processo di preparazione, organizzazione e distribuzione di documentazione software per utilizzatori di prodotti software
Chiarire il ruolo del redattore tecnico in un team di sviluppatori software e il valore che un redattore tecnico rappresenta per il team
Creare immagini, grafiche e infografiche di tipo istruzionale che sono richieste nella documentazione software utilizzando dei template predefiniti e progettati in maniera professionale
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.
Facilitare una comprensione e una pratica di base su come scrivere per gli sviluppatori, redigendo documentazione API con l’uso di Swagger UI.

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