Vandaag wil ik een paar momenten nemen om me te concentreren op iets dat ons allemaal aangaat, maar het is niet specifiek gerelateerd aan de code. Waar ik het over heb, zijn de mensen die de traditionele boeken en tijdschriftartikelen in opdracht geven die je elke dag leest en leert.
Wat je misschien niet beseft, is dat uitgevers de neiging hebben om verrassend strikte richtlijnen op te leggen aan schrijvers.
Voor degenen onder u die nog niet hebben bijgedragen aan een technisch boek of tijdschrift - of zelfs enkele commerciële blogs - wat u misschien niet zou realiseren, is dat uitgevers de neiging hebben om verrassend strikte richtlijnen op te leggen aan schrijvers.
De hierboven genoemde items vertegenwoordigen slechts een klein deel van de beperkingen die rusten op de schouders van een technisch schrijver. Waar het op neerkomt is: naast het ontcijferen van hoe het best ingewikkelde technologieën het best kan worden uitgelegd, moet een technisch schrijver ook op een of andere manier erin slagen om zijn inhoud binnen de grenzen van de verwarrende vooraf bepaalde richtlijnen van een uitgever te laten passen.
Voor de kers op de zaak - en om nog meer druk uit te oefenen op de schrijver - zullen een aantal (vrij intense) deadlines worden vastgesteld om ervoor te zorgen dat het boek op tijd wordt voltooid. Hoewel dit zeker begrijpelijk is, zijn uitgevers vaak vaak te ambitieus op de door hen gekozen data, wat geen verklaring is voor de fulltime baan en andere verantwoordelijkheden van de schrijver..
Dit model is verouderd en komt snel te vervallen als het niet is geadresseerd en gemoderniseerd.
Leercode is in veel opzichten een kunst.
Voordat we doorgaan met het kiezen van traditionele uitgevers, is het belangrijk om eerst te begrijpen waarom zij doen dit. Overweeg een tijdschrift met een eindig aantal pagina's beschikbaar voor een bepaald stuk inhoud - zeg, vijf pagina's. Als dit de enige beperking was, zou het nog steeds moeilijk zijn voor de schrijver. Leercode is in veel opzichten een kunst. Het vereist zowel een goed begrip van de technologie, als het vermogen om het op een zodanige manier uit te leggen dat iedereen het kan begrijpen. Hoe plaats je een abitrary woordtelling op kunst en uitleg? Welnu, het antwoord is dat je dat niet kunt - althans niet zonder veel opoffering en redactie.
Laten we doorgaan; nu we hebben vastgesteld dat Magazine X mogelijk slechts ruimte biedt voor vijf pagina's, komt de volgende beperking in de vorm van het vinden van een manier om je artikel in een vooraf gedefinieerde lay-outsjabloon te proppen, dat wil zeggen, niet bevorderlijk voor op elke manier, vorm of vorm aan het schrijfproces. Dit is waar de vereisten voor het tellen van afbeeldingen en per sectie in het spel komen.
Stel je voor dat je verteld wordt dat je moet beschrijven hoe dit stuk code werkt in 25-35 woorden. Gedaan? Stel je nu de offers voor die je zou moeten maken om je uitleg genoeg te wringen om aan die vereiste te voldoen! Wie profiteert hiervan?
De wrijving ligt in het feit dat deze sjablonen en macro's het schrijfproces niet in overweging nemen.
Vanuit het oogpunt van een niet-schrijver is het volkomen begrijpelijk waarom het nodig zou kunnen zijn om deze beperkingen in te stellen. Overweeg de uitgevers die honderden boeken per jaar organiseren en bewerken. In deze gevallen wordt het snel essentieel - voor hun eigen verstand - om sjablonen voor te bereiden en significant ingewikkelde Word-documenten en macro's om zoveel mogelijk te automatiseren.
Het probleem zit hem in het feit dat deze sjablonen en macro's het schrijfproces niet eens in overweging nemen. Nu, in plaats van zich te concentreren op wat het belangrijkst is (het uitleggen van ingewikkelde code), wordt de schrijver in plaats daarvan gedwongen om veel moeite en tijd te steken in het ontcijferen van hoe een bepaalde Word-macro te gebruiken, of hun document te formatteren, volgens de richtlijnen van de uitgever.
Een van de drie resultaten kan het gevolg zijn van een uitgever die pagina's met vereisten oplegt aan een schrijver, die niets liever wil dan een bepaalde technologie aan anderen te leren - en misschien de hypotheek in het proces te betalen. (Als je denkt dat de schrijvers van je favoriete technische boeken het voor het geld doen, denk dan opnieuw.)
Ik weet zeker dat je kunt raden welke optie hierboven het populairst is.
Op een gegeven moment had ik vergelijkbare vereisten voor Nettuts + bijdragers.
Ik moet toegeven dat ik op een gegeven moment vergelijkbare vereisten had voor Nettuts + bijdragers en schrijvers van het personeel. Gelukkig zorgt het formaat van een blog voor minder strenge eisen. Een vereisten voor het aantal woorden per afdeling is dom en zinloos voor een blog. Dat gezegd hebbende, benadrukte ik nog steeds het aantal woorden, het leveren van afbeeldingen en het gebruik van onze speciale Nettuts-specifieke HTML-sjabloon bij het voorbereiden van nieuwe tutorials.
Waarom? Welnu, om dezelfde reden als waarom traditionele uitgevers doen: mijn taak is het gemakkelijkst, wanneer het artikel in mijn vooraf bepaalde lay-out voor een Nettuts + -artikel past.
Waar ik geen rekening mee heb gehouden was het aantal potentiële schrijvers dat ik per ongeluk had weggedrukt, door deze vereisten te stellen. Wie heeft echt de tijd om te werken binnen de grenzen van iemands sjabloon? Wanneer tijd een kostbaar goed is (vooral voor mensen met bestaande fulltime banen en gezinnen), dienen deze grenzen niet meer dan een afschrikmiddel.
Tegenwoordig is mijn enige doel, bij het in dienst nemen van nieuwe inhoud, om het schrijfproces voor de auteur zo moeiteloos en natuurlijk mogelijk te maken.
Nu ik volwassen ben geworden als redacteur van Nettuts +, vraag ik bij het werken met nieuwe auteurs alleen een Markdown-bestand, wat voor hen die onbekend zijn, een pseudo-taal is die vooral ontwikkelaars de voorkeur geven. Markdown neemt de visuals en de opmaak volledig uit het schrijfproces, zoals het geval zou moeten zijn, vooral in onze branche. Als ze zich niet op hun gemak voelen bij Markdown, kunnen ze ook alles anders gebruiken om de klus te klaren.
Nu ik volwassen ben geworden als redacteur van Nettuts +, vraag ik bij het werken met nieuwe auteurs alleen een Markdown-bestand.
Misschien kan deze methode voor iets meer werk van mijn kant zorgen, maar absoluut en positief is de afweging de moeite waard. Ik wil dat onze schrijvers zich concentreren op niets anders dan het zo effectief mogelijk uitleggen van gecompliceerde technologieën. Wij zorgen voor de rest. Als alleen alle uitgevers een vergelijkbaar model hebben gebruikt.