Introduzione
Perché questa sezione?¶
Verso la fine del 2024, è apparso evidente che non tutti i documenti presenti nella cache della documentazione di Rocky Linux saranno delle guide. Avevamo bisogno di uno spazio per spiegazioni più lunghe e approfondite. Entrate in questo blog.
Chi può scrivere qui?¶
Chiunque abbia le credenziali di GitHub può inviare un articolo suggerito qui. Per iniziare, consultare i documenti nella [sezione Contributo] (https://docs.rockylinux.org/guides/contribute/).
Nota
Se non si ha le credenziali GitHub e si vuole comunque scrivere qualcosa per questa sezione, contattateci nel canale Mattermost in fondo a questa pagina.
Dovete assicurarvi che il vostro documento soddisfi i requisiti di questa sezione. Per esempio:
- E' adatta qui? Sono informazioni che vale la pena condividere? È un documento in stile blog?
- Approfondisce un tema importante per i documentaristi?
- La comunicazione migliorerà la qualità complessiva di tutta la documentazione di Rocky Linux?
Che tipo di informazione?¶
I primi due documenti qui riportati dovrebbero dare un'idea di ciò che fa al caso vostro. Nel corso del 2024, abbiamo concertato gli sforzi per eliminare o ridurre drasticamente le forme passive nei documenti di istruzioni how-to. Il documento [Active voice: The way to simple, clear, communication] (active_voice.md) descrive l'importanza della forma attiva nel tono della documentazione, nella facilità di lettura e comprensione e nella semplificazione della traduzione in altre lingue. Il documento [Open source: perché non viene mai sillabato] (open_source.md) discute il grande dibattito su questo argomento e le ragioni alla base della nostra decisione di non sillabare. Si è capito l'idea? Si tratta di documenti informativi che non includono informazioni sul funzionamento, se non come esempi.
La crescita di questo blog?¶
Questo insieme di documenti crescerà probabilmente più lentamente rispetto alle guide di istruzioni how-to. Questo e' prevedibile. L'aspetto più importante è la qualità e la validità dei documenti.
Suggerimenti¶
Come per il progetto di documentazione nel suo complesso, è possibile fornire un feedback nel nostro canale Documentation Mattermost.
Author: Spencer Steven