Progetto Open Source Geospatial Foundation

Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.

Riepilogo del progetto

Organizzazione open source:

Fondazione geospaziale open source

Technical writer:

flicstar

Nome progetto:

Consulta le guide rapide di OSGeoLive

Durata del progetto:

Durata standard (3 mesi)

Project description

Finalità

• Aggiorna i documenti per mantenerli aggiornati, precisi e pertinenti.
• Crea un modello per garantire la coerenza tra i documenti e per l'aggiunta di nuove guide rapide future.

Pubblico

• Nuovi utenti di OSGeo dal vivo
• Writer di nuove guide rapide di OSGeo Live

Consegna

• Wiki

Ecco cosa credo sia necessario fare:

1. Scopri le 50 guide rapide esistenti di OSGeo Live
2. Esegui il markup con le modifiche. Invia per la revisione.
3. Implementa la recensione/il feedback
4. Crea un modello della guida rapida per implementare la coerenza in futuro.
5. Aggiorna la sezione "Come eseguire una procedura di avvio rapido".
6. Aggiunta di nuove app a OSGeoLive, che necessitano delle guide rapide.

Cosa propongo di fare:

• Esamina le 50 guide rapide di OSGeo Live esistenti e applica il markup alle modifiche, utilizzando queste pagine come riferimento:

  Novità: https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file

  Precedente: https://wiki.osgeo.org/wiki/OSGeoLive_AddProject#Documentation

• Creazione dei problemi della documentazione in trac (Issue Tracker)

• Fornisci un report con un riepilogo dei risultati. Ad esempio, la percentuale di 50 che richiedono un impegno minimo, un impegno medio o molto.

• Crea un modello di guida rapida per implementare la coerenza in futuro.

• Aggiorna la pagina "Come documentare il file della guida rapida".

Alla fine di SoD:

• 50 ticket di documentazione in trac, con guide rapide con markup secondo il modello di guida rapida concordato
• Un'istantanea dello stato attuale delle guide rapide di OSGeo Live e delle attività necessarie per aggiornarle.
• Un modello di guida rapida aggiornato coerente con il modello di guida per la formazione.
• Una procedura di documentazione rapida aggiornata.

Da dove iniziare:

• Consulta il foglio di lavoro OSGeo-Live Packages per vedere quali pacchetti sono stati modificati tra una release e l'altra.
• Chiedi alla mailing list di OSGEo Live se ha suggerimenti su guide rapide specifiche con cui iniziare.

Che cosa ho già fatto:

• Configura la mia VM e installato OSGeoLive
• Fork del repository OSGeoLive-Doc
• Accesso a Trac e revisione di alcuni ticket documenti esistenti. Il biglietto n. 1382 sembra pertinente: https://trac.osgeo.org/osgeolive/ticket/1382
• Partecipazione a discussioni sulla mailing list
• Abbiamo tenuto alcune videochiamate informali