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:
- Il progetto FreeBSD
- Redattore tecnico:
- Il Re dei Tostapane
- Nome del progetto:
- Scrivi le pagine man mancanti, aggiungi sezioni di ESEMPIO alle pagine man
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Scrivi le pagine man mancanti:
Puoi trovare un elenco di pagine man mancanti all'indirizzo https://wiki.freebsd.org/MissingManpages. Inizia a scrivere il maggior numero possibile di pagine di questo elenco. Con l'aiuto del tuo mentore, trova l'autore o qualcuno che ha modificato di recente il file sorgente a cui si riferisce la pagina man in questione per avere informazioni di base e dettagli.
Aggiungi sezioni DI ESEMPIO alle pagine man:
Le pagine di manuali di FreeBSD includono in molti punti una sezione ESEMPLIO, che descrive l'utilizzo di base dell'utilità o del comando descritto al suo interno. La wiki di FreeBSD contiene un elenco di pagine man senza esempi (https://wiki.freebsd.org/ManPagesWithoutExamples). Aggiungi il maggior numero possibile di esempi a queste pagine di manuali nei casi in cui abbia senso averli. Stabilisci un modo generale per introdurre il comando/utilità in queste sezioni (ovvero l'avvio rapido prima, gli esempi più avanzati in seguito) e applicalo alle pagine man che descrivono utilità/comandi simili. In questo modo, gli esempi hanno un approccio coerente e il lettore può trovare più facilmente le informazioni.