Apple: documentazione da migliorare?

L’interessante caso di uno sviluppatore che, volendo lavorare con SwiftUI, scoprì che la documentazione di Apple era meno completa del previsto

Per moltissimi sviluppatori l’ecosistema Apple è uno dei più appetibili. Il successo di una piattaforma software deriva da diversi fattori, come l’accessibilità dei toolkit, la diffusione dei servizi connessi e, non ultima, la completezza della documentazione.

Una buona documentazione è infatti importatissima per consentire ai programmatori di padroneggiare una determinata tecnologia.

A tal proposito oggi vogliamo portarvi l’esperienza di Chris Krycho, software engineer indipendente, che di recente ha pubblicato un articolo sul suo blog personale dove evidenzia la scarsità della documentazione prodotta da Cupertino per SwiftUI:

Negli ultimi mesi ho approfondito, per il mio progetto personale rewrite, le mie conoscenze dell’ecosistema di sviluppo Apple. Dunque ho studiato Swift, SwiftUI e le API di iOS e MacOS. È stato terribile. Il numero delle parti interamente senza documentazione mi ha lasciato perplesso.

Secondo Krycho l’attuale stato della documentazione software di Apple lascia molto a desiderare. Ci sarebbero infatti intere sezioni di SwiftUI lasciate senza spiegazioni di alcun genere:

Swift è relativamente ben coperto ma le buone notizie finiscono qui. Gran parte della SwiftUI è interamente non documentata, in alcuni punti non è presente nemmeno una riga di testo. La documentazione di Swift Package Manager invece è ok ma riuscire a capire cosa è possibile fare e cosa no è veramente complicato. Il grande numero di domande su Stack Overflow su SwiftUI è la prova di tale situazione.

Per Krycho questa situazione è inaccettabile. In molti altri ecosistemi, come ad esempio Rust, prima di inviare il codice e di pubblicare nuove release è necessario compilare un’adeguata documentazione. Basterebbe che Apple adottasse questo regolamento per evitare inutili disagi agli sviluppatori di terze parti.

Krycho conclude il suo articolo suggerendo alla Mela Morsicata di darsi da fare per migliorare la documentazione dei suoi prodotti, non solo per fare un favore alla sua community di developer ma anche per stare al passo con i concorrenti presenti sul mercato.

I progetti open source da decenni puntano molto su questo elemento e aziende come Microsoft hanno adottato tale filosofia da diverso tempo.

Via Chris Krycho