Condividi i tuoi skill

OpenSkills è un progetto aperto a chiunque voglia condividere le proprie conoscenze informatiche.
Tutti gli utenti registrati possono scrivere Infobox, articoli e testi di diversa natura che raccolgono informazioni e nozioni su specifici argomenti.
Per collaborare in modo ottimale e scrivere Infobox coerenti con l'infrastruttura di OpenSkills è necessario conoscere la natura di questo sito.

echo "OpenSkills Structure"
Tutti gli argomenti di OpenSkills sono divisi in Topic (elenco) che possono essere relativi sia ad argomenti generali che più specifici.
Ogni Topic è composto da uno o più Infobox (elenco), che possono essere scritti dagli utenti registrati.
Un Infobox può anche appartenere a più Topic e, sopratutto, può essere di diverse tipologie (vedi sotto per dettagli) e livelli di difficoltà.
Ad ogni Infobox possono essere associate una o più Risorse Internet (elenco), che rappresentano link a siti di approfondimento, citazioni delle fonte, link ad una Google search word attinente ecc.
Per ogni Infobox, inoltre, è possibile sviluppare una Live Discussion (elenco) in cui tutti i visitatori del sito possono chiedere o commentare gli argomenti trattati.

echo "Infobox Nature"
Nel momento in cui si scrive un Infobox è necessario anche specificarne il tipo.
Questi sono i principali tipi di Infobox:

DESCRIPTION Tipico articolo descrittivo, con informazioni e dettagli sull'argomento del Topic correlato.
TIPS Consigli, suggerimenti pratici, informazioni tecniche.
COMMANDS Command reference, descrizione di un comando shell con le principali opzioni ed esempi d'uso.
PATH Path standard di file o directory con relativa spiegazione
BOFH Una riga di comando shell, anche complessa, utile per specifiche operazioni.
SCRIPTS Script commentati che eseguono funzioni utili.
STDOUT Output (eventualmente commentato) di una specifica attività sistemistica.
DISTRO Dettagli su singole distribuzioni Linux in riferimento all'argomento trattato.
ETCETERA Confronto su Sistemi Operativi diversi da Linux. In particolare altri Unix e Solaris.
WHITE PAPER Documenti di approfondimento sul Topic correlato. E' un DESCRIPTION più completo e articolato.
SAMPLE Esempi di file di configurazione funzionanti.
FUN Infobox divertente. Humour da sistemisit.
SLIDE Slide riassuntiva degli argomenti del Topic. Viene visualizzata con font espansi. (Uso Interno)
SUMMARY Riassunto delle informazioni essenziali di un topic - Il breviario di riferimento.
PRACTICE Esercizi pratici relativi agli argomenti trattati nel Topic correlato. (Uso Interno)
QUESTIONS Domande teoriche sul topic indicato. Per corsi. (Uso Interno)
TEACHER'S NOTES Note, informazioni, guidelines per il trainer su come trattare, in un corso, gli argomenti del topic (Uso Interno)
ARTICLES Articoli di OpenSkills scritti per altre testate.

echo "Writing Style"
Scrivere un Infobox adatto per OpenSkills richiede un minimo di attenzione e consapevolezza del contesto generale.
Innanzitutto va scelto il Topic adatto per l'articolo che si vuole scrivere. Se non si trova un Topic adeguato nell'elenco completo , scrivere alla redazione di OpenSkills con una proposta per un nuovo Topic.
Nello scrivere il testo tenere in considerazione i seguenti punti:
- Se il livello di difficoltà è basso, è necessario usare un linguaggio semplice e spiegare tutto, se è alto, ci si aspetta che il lettore già conosca alcuni concetti per cui è inutile spiegare informazioni di background generali o dilungarsi in spiegazioni eccessive.
- Non esiste un solo Linux e un solo posto in cui si trovano file di configurazione, log ecc. Quando si descrive un dato argomento cercare di essere precisi e indicare a quale distribuzioni sono riferiti i comandi dati. L'ideale sarebbe descrivere un argomento avendo presente e spiegando come viene gestito su distribuzioni diverse.
- Non usare un tono troppo colloquiale, in prima persona, con aneddoti sui propri sistemi o esperienze. Gli articoli di OpenSkills vanno visti come riferimento tecnico, eventualmente distribuito in Guide e pubblicazioni, non come una sorta di blog, dove un linguaggio più informale non risulta fuori luogo.
- Verificare errori di scrittura e battitura. Usare termini inglesi all'interno di testo italiano in modo corretto (non mettere le s finali per i plurali, per esempio). Verificare la correttezza di quanto si scrive.
- Gli articoli di OpenSkills dovrebbero avere qualcosa in più rispetto ad altre fonti di documentazione di medio livello. Dovrebbero fornire informazioni precise, utili, presentate in modo chiaro, dando importanza ai casi reali, alla utilità delle informazioni fornite al valore aggiunto del testo che si scrive e a cosa può dare a chi lo legge.
- Ovviamente gli articoli devono essere originali: l'autore che li scrive su OpenSkills non deve in alcun modo copiarli, senza autorizzazione, da altre parti. E' bene, in ogni occasione, specificare fra le Risorse Internet associate all'Infobox le fonti su cui ci si è basati per la stesura del pezzo.

echo "Formatting Style "
Esiste una convenzione, più o meno uniforme, che descrive gli stili HTML che si possono usare nello scrivere un Infobox su OpenSkills.
La gran parte dei tag html, per ovvi motivi di sicurezza, è disabilitata, ma quelli permessi bastano a caratterizzare il testo per renderlo leggibile e strutturato:

<b> Da utilizzare per evidenziare parole chiave all'interno del testo o per i titoli di eventuali paragrafi o sezioni di un Infobox
<i> Utilizzabile per evidenziare specifiche parole di un testo
<code> IMPORTANTE: Rappresenta lo Standard Input (STDIN), di fatto i comandi che l'utente scrive con la tastiera.
Va anche usato quando si indicano i path di file o directory o quando si visualizza il contenuto di un file di configurazione.
<samp> Rappresenta lo Standard Output (STDOUT) del sistema: di fatto quello che viene mostrato a video quando l'utente digita un dato comando.
<cite> Può essere usato per commenti o spiegazioni all'interno di file di configurazione, script e altri testi in cui si usano i tag <code> o <samp>
<var> Va usato, all'interno di file di configurazione o script, per evidenziare parametri variabili che chi legge deve adattare al contesto in cui lavora (esempio: indirizzi IP, nomi di dominio ecc.)
<a> E' possibile inserire link all'interno del testo, anche se si suggerisce di utilizzare le Risorse Internet correlate all'Infobox per indicare link di approfondimento e fonti.
Privacy Policy