Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione di Documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Apache Flink
- Technical Writer:
- haseeb1431
- Nome del progetto:
- Estensione della documentazione di API Table e SQL per Apache Flink
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Sto inviando la mia richiesta per il GSOD su "Estendere la documentazione dell'API Table e di SQL". Scriveremo la documentazione dell'API in modo che anche la nonna possa scrivere query. Potremmo già avere la struttura, ma la esamineremo come utenti principianti e suggeriremo idee dove necessario. Ho intenzione di collaborare strettamente con i mentor per comprendere il loro processo di pensiero e condividere idee diverse in base alla mia esperienza precedente nel settore.
Alcune considerazioni iniziali sulla base della documentazione attuale sono:
La pagina Panoramica contiene attualmente molte informazioni, ma deve essere riesaminata e ordinata in modo che sia l'utente principiante che l'utente avanzato possano iniziare rapidamente. La mia idea è avere un inizio con diversi percorsi possibili: a) avviare un nuovo progetto ed eseguire le query su di esso, b) eseguire query SQL o API Table su un progetto esistente.
Inoltre, dobbiamo avere una mappa completa della documentazione dell'API nella pagina di destinazione in modo che gli utenti possano vedere tutte le possibilità a colpo d'occhio. Sarà una versione migliorata della sezione "Dove andare dopo" nell'attuale pagina Panoramica.
La pagina del concept ha contenuti abbastanza buoni, ma sono troppo concentrati in una singola pagina, quindi avremo alcune sottosezioni in questa pagina. Analogamente, altre sezioni come Pianificatori, Funzioni integrate e Connettori richiedono una maggiore visibilità, ad esempio nella pagina Panoramica o nella barra di navigazione a sinistra. La pagina Connettori può essere suddivisa in più sottosezioni, ad esempio connettori, formati e così via. Le funzioni di sistema (integrate) mi sembrano buone, dato che in un'unica pagina sono disponibili tutti i metodi possibili e gli utenti possono sempre farvi riferimento come schede di riferimento, ma saranno lieti di aggiungere altri contenuti in merito.
Il periodo di tre mesi sarà suddiviso in diverse fasi. Inizialmente, creeremo una struttura, come una Sitemap, della documentazione dell'API Tables e SQL. Introdurremo le sottosezioni e le trame descritte in precedenza. Una volta completata, possiamo sottoporla a revisione con utenti di livello avanzato e principiante. D'altra parte, possiamo iniziare a scrivere di pianificatori e connettori mentre aspettiamo il feedback. Una volta ricevuto il feedback, ristrutturaremo la documentazione dell'API. Ora ci concentreremo sul completamento della scrittura delle sezioni in attesa. Infine, se il tempo lo consente, ho intenzione di prendere un esempio da zero e mostrare l'implementazione di un progetto end-to-end che può essere utilizzato per FLINK-12639.
Propongo di poter organizzare un incontro di un'ora dopo due settimane, escluse le chat su Slack (o qualsiasi altro strumento). Condividerò una sequenza temporale iniziale del progetto con le settimane previste, che ci aiuterà a monitorare i progressi del progetto anche su base settimanale.
Infine, questa documentazione è simile al nostro blog su medium.com, dove aggiungiamo tutti i dettagli di base quando apprendiamo le diverse funzionalità dell'API Flink. Inoltre, mi rende un candidato unico in quanto verificherò la documentazione con implementazioni pratiche anziché limitarmi a scrivere la documentazione tecnica. Questo progetto sarà una sorta di "doppia spada" perché contribuirà alla documentazione open source mentre approfondirò l'API Tables e SQL.