Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- moja global
- Redattore tecnico:
- Anthony
- Nome del progetto:
- Documentazione sul codice dello strumento di generazione dei report
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Data l'opportunità di documentare lo strumento di generazione di report per l'organizzazione Moja Global, propongo di sviluppare sei tipi di documentazione che verranno utilizzati da segmenti di pubblico diversi per raggiungere scopi diversi. Questi sono riassunti di seguito:
1) Guida alla configurazione dell'ambiente
1.1) Pubblico di destinazione: System Engineer
1.2) Scopo Aiutare i tecnici di sistema a configurare un ambiente di compilazione ed esecuzione locale per lo strumento di generazione di report.
1.3) Formato Un articolo dettagliato che prescrive l'insieme di passaggi sequenziali che gli ingegneri di sistema devono seguire per configurare l'ambiente che sarà favorevole alla creazione e all'esecuzione dello strumento di generazione di report.
2) Guida allo sviluppo
2.1) Pubblico di destinazione: System Engineer
2.2) Scopo Aiutare i sistemisti a creare i componenti dello strumento di generazione di report dal codice sorgente
2.3) Formato Un articolo di istruzioni che prescrive l'insieme di passaggi sequenziali che gli ingegneri di sistema devono eseguire per ottenere e compilare il codice sorgente dello strumento di reporting.
3) Guida all'installazione
3.1) Tecnici di sistema del pubblico di destinazione
3.2) Scopo: aiutare i tecnici di sistema a installare i componenti dello strumento di generazione di report appena creati
3.3) Formato Un articolo del Centro assistenza che descrive la serie di passaggi sequenziali che gli ingegneri di sistema devono eseguire per eseguire il deployment dello strumento di generazione di report in un ambiente appena configurato.
4) Guida all'uso
4.1) Pubblico di destinazione: integratori di sistema
4.2) Obiettivo Aiutare gli ingegneri di sistema a eseguire un'istanza dello strumento di reporting appena installata
4.3) Formatta un articolo dettagliato che prescriva la serie di passaggi sequenziali che gli integratori di sistema devono eseguire per caricare ed elaborare i database di output di Flux in un'istanza dello strumento di generazione di report in esecuzione.
Guida alle operazioni Onboarding ed elaborazione dei database di output Flux nello strumento di reporting
5) Guida dell'utente
5.1) Pubblico di destinazione Utenti finali
5.2) Scopo: aiutare gli utenti finali a comprendere le diverse funzionalità integrate nello strumento di generazione di report e come utilizzarle.
5.3) Formato Un articolo dettagliato che prescrive la serie di passaggi sequenziali che gli utenti finali devono seguire per utilizzare correttamente le funzionalità dello strumento di generazione dei report.
6) Guida allo sviluppo
6.1) Pubblico di destinazione Programmatori
6.2) Scopo: aiutare gli utenti finali a comprendere le diverse funzionalità integrate nello strumento di generazione di report e come utilizzarle.
6.3) Formato Articoli di riferimento che descrivono: a) i principali elementi di progettazione che compongono lo strumento b) la decomposizione funzionale degli elementi di cui sopra c) gli elementi di esecuzione degli elementi scomposti funzionalmente d) l'organizzazione del codice sorgente / delle librerie dello strumento e) la visione e la direzione a lungo termine per il miglioramento continuo f) le successive aree logiche di miglioramento
e un breve tutorial che descrive come il codice può essere adattato alle circostanze specifiche dell'utente