Archivi categoria: documentazione

Plain Language

Scrivere in modo semplice (Plain Language) per farsi capire meglio da chi ci leggerà.

E’ importante sempre, e lo è in particolare per le specifiche dei requisiti e di analisi dei sistemi informatici, condivise e lette da persone con ruoli diversi:

  • committenti, utenti e altre parti interessate (stakeholder)
  • progettisti e sviluppatori software
  • tester (verificatori del corretto funzionamento del sistema)
  • redattori di manuali operativi

In questa pagina ho riportato una serie di indicazioni e riferimenti: Scrivere in modo semplice.

Un articolo recente del Nielsen Norman Group sottolinea l’importanza del Plain Language anche quando si scrive per un pubblico di esperti: Plain Language Is for Everyone, Even Experts.

Arc42, per documentare le architetture software

Arc42 è un framework semplice e concreto per documentare le architetture software. L’impostazione è essenziale, ma completa.

Basato su una serie di template, è stato realizzato da Gernot Starke e Peter Hruschka, ed è usabile  gratuitamente e senza vincoli. Prevede come opzione, anche se non obbligatoria, l’uso di UML.

Le caratteristiche di Arc42 vengono spiegate in questa intervista su Software Engineering Radio.