Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- moja globale
- Technical writer:
- Anthony
- Nome progetto:
- Documentazione sul codice dello strumento di segnalazione
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Data l'opportunità di documentare lo strumento di generazione dei report per l'organizzazione Moja Global, propongo di sviluppare sei tipi di documentazione che verranno utilizzati da diversi segmenti di pubblico per raggiungere scopi diversi. Eccone un riepilogo:
1) Guida alla configurazione dell'ambiente
1.1) Tecnici di sistema per il pubblico di destinazione
1.2) Obiettivo Aiutare gli ingegneri di sistema a configurare un ambiente di creazione ed esecuzione locale per lo strumento di generazione dei report.
1.3) Formato Un articolo di istruzioni che prescrive l'insieme di passaggi sequenziali che i Tecnici di sistema devono intraprendere per configurare l'ambiente che favorirà la creazione e l'esecuzione dello Strumento di reporting.
2) Guida allo sviluppo
2.1) Tecnici di sistema per il pubblico di destinazione
2.2) Obiettivo Aiutare gli ingegneri di sistema a creare i componenti dello strumento di generazione dei report a partire dal codice sorgente
2.3) Formato Un articolo di istruzioni che prescrive l'insieme di passaggi sequenziali che i Tecnici di sistema devono eseguire per ottenere e compilare il codice sorgente dello Strumento di reporting.
3) Guida all'installazione
3.1) Tecnici di sistema per il pubblico di destinazione
3.2) Obiettivo Aiutare gli ingegneri di sistema a installare i nuovi componenti degli strumenti di generazione dei report
3.3) Formato Un articolo di istruzioni che prescrive l'insieme di passaggi sequenziali che gli ingegneri di sistema devono eseguire per implementare lo strumento di reporting in un ambiente appena configurato.
4) Guida operativa
4.1) Integratori di sistemi per il pubblico di destinazione
4.2) Obiettivo Aiutare gli ingegneri di sistema a eseguire un'istanza dello strumento di reporting appena installata
4.3) Formato Un articolo di istruzioni che prescrive l'insieme di passaggi sequenziali che gli integratori di sistema devono eseguire per caricare ed elaborare i database di output di flusso su un'istanza dello strumento di reporting in esecuzione.
Guida operativa Integra ed elabora i database di flussi di output nello strumento di generazione dei report
5) Guida dell'utente
5.1) Pubblico di destinazione: Utenti finali
5.2) Obiettivo Aiutare gli Utenti finali a comprendere le diverse funzionalità incorporate nello Strumento di segnalazione e come devono essere utilizzate.
5.3) Formato Un articolo di istruzioni che prescrive l'insieme di passaggi sequenziali che gli Utenti finali devono eseguire per utilizzare correttamente le Funzionalità dello Strumento di generazione dei report.
6) Guida per lo sviluppo
6.1) Destinatari dei programmatori
6.2) Obiettivo Aiutare gli Utenti finali a comprendere le diverse funzionalità incorporate nello Strumento di segnalazione e come devono essere utilizzate.
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) il codice sorgente o l'organizzazione delle librerie dello strumento e) la visione e la direzione a lungo termine per il miglioramento continuo f)le successive aree logiche da migliorare
Un breve tutorial che descrive come il codice può essere modificato in base alle circostanze specifiche dell'utente.