Come si scrivono blog tecnici? [chiuso]

Scrivere è difficile, scrivere bene è ancora più difficile. Il fatto di cercare di spiegare qualcosa è che richiede più conoscenza quindi semplicemente "un po 'lo so". Trovo che con il blogging io 1. trovi argomenti correlati che ho bisogno di capire, 2. identifica dove la mia comprensione è superficiale

Leggi attraverso queste diapositive link . Spiegano molto sulla scrittura (e la confronta persino con la programmazione)

Ogni lavoro di qualità richiede tempo e impegno. È normale.

Alcuni dei miei vecchi post di blog hanno richiesto circa 3 settimane per essere completato. Scrivi una bozza, la rilegge, apporta le correzioni necessarie, la scansiona ancora e la rilegge. Ci vuole tempo.

Una semplice idea su come mantenersi motivati. Se stai pianificando qualcosa di grande, considera se avrebbe senso dividere il lavoro in 2-3 parti e pubblicarlo separatamente. Le parti devono ovviamente essere utili ai tuoi lettori per conto proprio. Quindi, poiché impiegano meno tempo, è più probabile che riescano a completarlo e portare a termine il lavoro parziale.

Alcuni suggerimenti da questo blogger tecnico sconosciuto:

• Verifica (non solo leggi) il codice che hai inserito tagliando e incollando dall'anteprima alla riga di comando o un file di testo da eseguire. Diverse cose (come la fine della linea, il rientro e i caratteri Unicode) possono essere incasinati durante il trasferimento da un editor (o shell) a una pagina Web e viceversa.
• Ottieni un umano per controlla ortografia, grammatica e contenuti : mostra che è stato fatto qualche sforzo per rendere gli articoli corretti e facili da leggere. Se non c'è nessuno, assicurati di rileggere l'intero articolo prima di pubblicarlo.
• Se la piattaforma di blogging ha evidenziazione della sintassi , usala. In caso contrario, inserisci il codice da qualche parte che lo ha e link lì.
  • Corollario: tieni lontani enormi pezzi di codice dal testo dell'articolo. Questo è un po 'vago, ma se il testo sta spiegando come funziona un codice, va bene includere uno snippet. Se presenta un software da scaricare, è meglio fare riferimento a un'interfaccia web VCS.
• Ogni articolo dovrebbe essere leggibile da solo . Fare riferimento ad altri articoli va bene, ma non dare per scontato che il lettore abbia letto altri post prima di questo.
• Utilizza altri formati del testo quando facilitano la comprensione. Per alcune cose il codice è sufficiente, ma per alcuni un'immagine o persino un'animazione potrebbe essere molto più comprensibile.

Spesso trovo che un post sul blog difficile impieghi così tanto tempo perché richiede una ricerca; questa ricerca non aiuta solo il tuo post sul blog, ma ti aiuta a sviluppare le tue conoscenze personali nel processo. Come hai detto, stai rafforzando la conoscenza scrivendo il post; stai anche espandendo le tue conoscenze. Abbraccia il tempo necessario e valutalo come un'esperienza di apprendimento.

Sì, è normale che la scrittura del blog tecnico richieda tempo. Per me, la scrittura richiede il minor tempo possibile (meno di un'ora, o fino a un giorno, a seconda della lunghezza). In genere, la modifica e la riscrittura richiedono più tempo (fino a due o anche tre giorni). Un altro aspetto che è stato menzionato richiede tempo per chiarire qualsiasi codice di esempio. Inoltre, mi piace passare il tempo a trovare link di supporto per i miei argomenti. Tutto richiede tempo!

Suppongo che ora potresti scrivere blog tecnici Ma ti suggerirei di farlo quando diventi esperto in un particolare dominio. Trascorrere un fine settimana non sembra troppo tempo. tutto dipende dalla complessità dell'argomento. Immagino che quello che sto dicendo sia che il nucleo della tua idea venga a te naturalmente l'esecuzione potrebbe richiedere più tempo.

Le persone sono alla ricerca di consigli di esperti in un blog ... non in esperimenti di noobs. ma sto parlando in senso generale .. Non voglio scoraggiarti a scrivere blog. Ma tieni a mente le seguenti cose.

1. Il tuo blog dovrebbe dire qualcosa di nuovo. Non raccogli dati e non li metti nel tuo proprio blog

2. Sii assolutamente sicuro di ciò che stai dicendo: atteniti a forti risultati empirici o concetti altamente testati o cose che hai provato di prima mano .

3. Sii pronto per le critiche.

4. Scopri le tecniche di scrivere blog (precisione, concisione, ecc.)

5. Scrivi qualcosa perché tu pensi che possa essere scritto; non perché pensi che sarà da leggere.

Gli elementi di stile

Penso che la scrittura tecnica segua molte delle stesse regole di qualsiasi scrittura. Se leggi solo un libro sulla scrittura, dovrebbe essere il classico Strunks "Elementi di stile" . Passa attraverso un elenco di cose che miglioreranno la tua composizione, essendo il primo (IMO), "Ometti parole inutili".

Raccomando anche " In scrittura " di Stephen King. Pur essendo più sulla scrittura di finzione, contiene ancora molte gemme per ogni aspirante scrittore, specialmente in aree come l'editing e il processo di scrittura.

Detto ciò, la cosa difficile della scrittura tecnica non è la scrittura vera e propria, ma chiarire i tuoi pensieri riguardo alla cosa di cui stai scrivendo. Il pensiero confuso porta a una cattiva scrittura. La buona scrittura richiede di avere una chiara comprensione del tuo argomento, ed è per questo che l'insegnamento e la scrittura sono un ottimo modo per padroneggiare un argomento.

Bene, mi ci vuole un sacco di tempo per scrivere post sul blog, sì. Li scrivo spesso per diversi giorni, o li lasciamo in giro in forma di bozza per un paio di settimane, di tanto in tanto li rileggo e correggo e aggiusto un po 'qua e là.

Ci vuole tempo, ma se questo è il prezzo per scrivere qualcosa di cui non mi vergogno dopo, ne vale la pena.