Come scrivi blog tecnici? [chiuso]

Di solito leggo molto sulla programmazione. Quando l'argomento che leggo non è direttamente correlato al mio lavoro (ad esempio leggendo di alcuni algoritmi che non utilizzo nel lavoro quotidiano), li dimentico.

Un modo per rafforzare ciò che è stato appreso è scrivere blog. Sono un principiante nella scrittura di blog. Quando ho iniziato a scrivere, ho capito che è molto difficile. Anche la semplice riproduzione del contenuto richiede circa due ore. Scrivere un blog ben ponderato richiede spesso un'intera giornata o talvolta un fine settimana.

È normale? Qualche consiglio per scrivere tutorial tecnici / blog tecnici?

Scrivere è difficile, scrivere bene è ancora più difficile. Il fatto di provare a spiegare qualcosa è che richiede più conoscenza di quanto non lo sappia. Trovo che tramite i blog 1. scopro argomenti correlati che devo capire, 2. identifico dove la mia comprensione è superficiale

Leggi queste diapositive http://www.ai.uga.edu/mc/WriteThinkLearn.pdf . Spiegano molto sulla scrittura (e persino la paragonano alla programmazione)

Ogni lavoro di qualità richiede tempo e fatica. È prevedibile.

Per completare alcuni dei miei vecchi articoli sul blog sono state necessarie circa 3 settimane. Scrivi una bozza, la rileggi, apporti le correzioni necessarie, la scansiona di nuovo e poi la rileggi. Richiede tempo.

Una semplice idea su come rimanere motivati. Se stai pianificando qualcosa di grande, considera se avrebbe senso dividere il lavoro in 2-3 parti e pubblicarle separatamente. Naturalmente le parti devono essere utili ai tuoi lettori da sole. Quindi, poiché richiedono meno tempo, è più probabile che tu riesca e porti a termine il lavoro parziale.

Alcuni consigli da questo sconosciuto blogger tecnico:

• Verifica (non solo letto) il codice che hai inserito tagliando e incollando dall'anteprima alla riga di comando o un file di testo da eseguire. Diverse cose (come terminazioni di riga, rientri e caratteri Unicode) possono incasinarsi durante il trasferimento da un editor (o shell) a una pagina Web e viceversa.
• Chiedi a un essere umano di controllare l'ortografia, la grammatica e i 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 l' evidenziazione della sintassi , usala. In caso contrario, pubblica il codice da qualche parte che lo possiede e collegalo lì.
  • Corollario: mantieni enormi blocchi di codice lontano dal testo dell'articolo. Questo è un po 'vago, ma se il testo spiega come funziona un po' di 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.
• Utilizzare altri formati oltre al testo quando aiutano la comprensione. Per alcune cose il codice è sufficiente, ma per alcune un'immagine o anche l'animazione potrebbe essere molto più comprensibile.

Spesso trovo che un post di blog difficile richieda così tanto tempo perché richiede ricerca; quella ricerca non solo aiuta 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 ampliando le tue conoscenze. Abbraccia il tempo necessario e valutalo come un'esperienza di apprendimento.

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

Immagino che ora potresti scrivere blog tecnici Ma ti suggerirei di farlo quando diventerai esperto in un determinato dominio. Trascorrere un fine settimana non sembra troppo tempo. tutto dipende dalla complessità dell'argomento. Immagino che ciò che sto dicendo sia che il nucleo della tua idea dovrebbe venire da te naturalmente. L' esecuzione potrebbe (e ci vorrà) più tempo.

Le persone sono alla ricerca di alcuni consigli di esperti in un blog .. non è un esperimento 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 basta raccogliere i dati e metterlo sul vostro proprio blog

2. Siate assolutamente sicuri di ciò che state dicendo, vale a dire attenetevi a forti risultati empirici o concetti altamente testati o cose che avete sperimentato in prima persona .

3. Sii pronto per le critiche.

4. Impara le tecniche di scrittura dei blog (precisione, concisione, ecc.)

5. Scrivi qualcosa perché si pensa che shud essere scritta; non perché pensi che verrà letto.

Gli elementi di stile

Penso che la scrittura tecnica segua quasi le stesse regole di qualsiasi scrittura. Se leggi solo un libro sulla scrittura dovrebbe essere il classico Strunks "The Elements of Style" . Passa attraverso un elenco di cose che miglioreranno la tua composizione, in primo luogo (IMO), "Ometti parole inutili".

Consiglierei anche " On Writing " di Stephen King . Pur riguardando maggiormente la scrittura fittizia, contiene ancora un sacco di gemme per qualsiasi aspirante scrittore, specialmente in settori come l'editing e il processo di scrittura.

Detto questo, la cosa difficile della scrittura tecnica non è la scrittura reale, ma chiarire i tuoi pensieri sulla cosa di cui stai scrivendo. Il pensiero confuso porta alla cattiva scrittura. Una buona scrittura richiede di avere una chiara comprensione del tuo argomento, motivo per cui insegnare e scrivere è un modo eccellente per padroneggiare una materia.

Beh, mi ci vuole un sacco di tempo per scrivere post sul blog, sì. Le scrivo spesso per diversi giorni, o addirittura le lascio in forma di bozza per un paio di settimane, a volte rileggendole e correggendole e modificandole un po 'qua e là.

Ci vuole tempo, ma se questo è il prezzo per scrivere qualcosa di cui non mi vergogno più tardi, penso che ne valga la pena.