Share
Idag vill jag ta några ögonblick för att fokusera på något som påverkar oss alla, men det är inte specifikt kodrelaterat. Vad jag hänvisar till är de som beställer de traditionella böckerna och tidskriftsartiklarna som du läser och lär dig från varje dag.
Vad du kanske inte inser är att utgivare har en tendens att genomföra överraskande strikta riktlinjer på författare.
För er som inte har bidragit till en teknisk bok eller tidskrift - eller till och med några kommersiella bloggar - vad du kanske inte inser är att utgivare har en tendens att genomföra överraskande strikta riktlinjer för författare.
De ovan angivna punkterna representerar endast en liten del av restriktionerna som ligger på en teknisk författares axlar. Vad det här betyder är: förutom att dechiffrera hur man bäst kan förklara betydligt komplexa tekniker måste en teknisk författare också på något sätt lyckas anpassa sig till innehållet inom gränserna för en utgivares förvirrande förutbestämda riktlinjer.
För isbildning på fallet - och att tillämpa ännu mer tryck på författaren - kommer en rad (ganska intensiva) tidsfrister att sättas för att säkerställa att boken är klar i tid. Även om det här är säkert förståeligt, tenderar utgivare ofta att vara för ambitiösa i de datum de väljer, vilket inte tar hänsyn till författarens heltidsjobb och andra ansvarsområden.
Denna modell är utdaterad och snart närmar sig utrotning, om den inte behandlas och moderniseras.
Undervisningskoden är på många sätt en konst.
Innan vi fortsätter att plocka på traditionella förlag är det viktigt att först förstå Varför de gör det här. Tänk på en tidning med ett begränsat antal sidor tillgängliga för ett visst innehåll - säg fem sidor. Om detta var den enda begränsningen skulle det fortfarande vara svårt för författaren. Undervisningskoden är på många sätt en konst. Det kräver både en förståelse av tekniken, liksom förmågan att förklara det på ett sådant sätt att alla kan förstå det. Hur lägger du ett orättfärdigt ordräkning på konst och förklaring? Tja, svaret är att du inte kan - åtminstone inte utan betydande offer och redigering.
Låt oss fortsätta på; nu när vi har fastställt att Magazine X bara får plats för fem sidor, kommer nästa begränsning i form av att hitta ett sätt att klämma in din artikel i en fördefinierad layoutmall, det är naturligtvis inte tillförlitlig för på något sätt, form eller form till skrivprocessen. Det är här där kraven på bild- och per-ordordräkning kommer att spelas in.
Tänk dig att få veta att du måste beskriva hur denna kod fungerar i 25-35 ord. Gjort? Nu, föreställ dig de offer som du måste göra, för att rita din förklaring tillräckligt för att passa det kravet! Vem drar nytta av detta?
Ruben ligger i det faktum att dessa mallar och makron inte tar hänsyn till skrivprocessen.
Ur ett icke-författarens perspektiv är det helt förståeligt varför det kan vara nödvändigt att ställa in dessa begränsningar. Tänk på förlag som organiserar och redigerar hundratals böcker per år. I dessa fall blir det väsentligt - för egen sanity - att förbereda mallar, och väsentligt komplexa Word-dokument och makron för att automatisera så mycket som möjligt.
Ruben ligger i det faktum att dessa mallar och makron inte ens börjar ta hänsyn till skrivprocessen. Nu, istället för att fokusera på det som är viktigast (förklarar komplicerad kod), är författaren istället tvungen att lägga stor ansträngning och tid för att dechiffrera hur man använder ett visst Word-makro eller formaterar sitt dokument, enligt utgivarens riktlinjer.
Ett av tre resultat kan bero på att en förläggare ställer krav på sidor på en författare, som bara vill ha en särskild teknik till andra - och kanske betala hypotekslån i processen. (Om du tror att dina favoritböcker författare gör det för pengarna, tänk igen.)
Jag är säker på att du kan gissa vilket alternativ ovan brukar vara mest populära.
Vid en tidpunkt hade jag liknande krav för Nettuts + bidragsgivare.
Jag måste erkänna att jag på samma gång hade liknande krav för Nettuts + bidragsgivare och personalförfattare. Lyckligtvis gör formatet för en blogg naturligtvis mindre stränga krav. Ett krav på per-talordräkning är dumt och meningslöst för en blogg. Det sagt, jag betonade fortfarande ordet tal, tillhandahålla bilder, och använda vår speciella HTML-mall för nätutbyte när du förbereder nya handledning.
Varför? Tja, av samma anledning som varför traditionella förlag gör: Mitt jobb är det enklaste, när artikeln passar min förutbestämda layout för en Nettuts + artikel.
Vad jag inte tog i beaktande var antalet potentiella författare som jag oavsiktligt tryckte bort, genom att ställa dessa krav. Vem har ärligt haft tid att arbeta inom ramen för någon annans mall? När tiden är en dyrbar råvara (speciellt för dem med befintliga heltidsjobb och familjer), tjänar dessa begränsningar att inte vara mer än avskräckande.
För närvarande är mitt enda mål, när jag påbörjar nytt innehåll, att göra skrivprocessen för författaren så enkel och naturlig som möjligt.
Nu när jag har mognat som redaktör för Nettuts +, när jag arbetar med nya författare, begär jag bara en Markdown-fil, som för de obekanta är ett pseudo-språk som utvecklare i synnerhet tenderar att föredra. Markdown tar bilderna och formateringen helt ur skrivprocessen, vilket borde vara fallet - speciellt i vår bransch. Alternativt, om de inte känner sig bekväma med Markdown, är de fritt att använda något annat för att få jobbet gjort.
Nu när jag har mognat som redaktör för Nettuts +, när jag arbetar med nya författare, begär jag bara en Markdown-fil.
Kanske kan den här metoden leda till lite mer arbete från min sida, men det är absolut och positivt värt avvägningen. Jag vill att våra författare fokuserar på ingenting annat än att förklara komplicerade tekniker så effektivt som möjligt. Vi tar hand om resten. Om bara alla utgivare antog en liknande modell.
Accentsconagua