Progetto Open Source Geospatial Foundation

Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.

Riepilogo progetto

Organizzazione open source:

Open Source Geospatial Foundation

Technical Writer:

flicstar

Nome del progetto:

Esamina le guide rapide di OSGeoLive

Durata del progetto:

Durata standard (3 mesi)

Project description

Finalità

• Aggiorna i documenti per mantenerli aggiornati, accurati e pertinenti.
• Crea un modello per garantire la coerenza tra i documenti e per i nuovi Quickstart che verranno aggiunti in futuro.

Pubblico

• Nuovi utenti di OSGeo live
• Writer delle nuove guide rapide di OSGeo Live

Delivery

• Wiki

Ecco cosa penso debba essere fatto:

1. Esamina le 50 guide rapide di OSGeo Live esistenti
2. Markup con modifiche. Invia per la revisione.
3. Implementare la recensione/il feedback
4. Crea un modello di guida rapida per implementare la coerenza per il futuro.
5. Aggiorna la sezione "Come eseguire una procedura di avvio rapido".
6. Aggiungi nuove app a OSGeoLive: richiedono la guida rapida.

Ecco cosa propongo di fare:

• Esamina le 50 guide rapide di OSGeo Live esistenti e applica il markup con le 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

• Creare problemi relativi alla documentazione in Trac (tracker dei problemi)

• Fornisci un report che riepiloghi il risultato. Ad esempio, la percentuale di 50 che richiedono un lavoro minimo, medio o molto.

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

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

Cosa avrai alla fine del SoD:

• 50 ticket di documentazione in Trac, con guide rapide contrassegnate in base al modello di guida rapida concordato
• Uno snapshot dello stato attuale dei Quickstart di OSGeo Live e la quantità di lavoro necessaria per aggiornarli.
• Un modello di guida rapida aggiornato in linea con il modello della Guida all'addestramento.
• Una procedura di documentazione della guida rapida aggiornata.

Da dove inizierò:

• Consulta il foglio di lavoro dei pacchetti OSGeo-Live per vedere quali pacchetti sono cambiati tra le release.
• Chiedi alla mailing list di OSGEo Live se ha suggerimenti per guide rapide specifiche con cui iniziare.

Ecco cosa ho già fatto:

• Ho configurato la VM e installato OSGeoLive
• È stato creato un fork del repository OSGeoLive-Doc
• Ho ottenuto l'accesso al trac e ho esaminato alcuni ticket di Documenti esistenti. Il ticket 1382 sembra pertinente: https://trac.osgeo.org/osgeolive/ticket/1382
• Ho partecipato alle discussioni con mailing list
• Abbiamo fatto alcune chat video informali