Live data from Hacker News

How to write a programming book

aquicarattino.com

21–30 of 71 posts

Re: How to write a programming book

#21

This would be interesting if I could read it. Would it be possible to display text without enabling JS? I have read several IT books recently and they aren't good. Basic stuff like visibility of diagrams, presenting advanced subject matter but also supposedly in a way that will teach you programming, or having pages of code to illustrate something trivial.

Yeah, I'm getting pretty sick of sites that want to run JS to show static content.

Re: How to write a programming book

#22
post #16

This would be interesting if I could read it. Would it be possible to display text without enabling JS? I have read several IT books recently and they aren't good. Basic stuff like visibility of diagrams, presenting advanced subject matter but also supposedly in a way that will teach you programming, or having pages of code to illustrate something trivial.

I'm working on that. I just used a stock template for the website.

Cheers! Much appreciated. :-)

Re: How to write a programming book

#23
post #10

What pains me about programming books is that due to the market pressure the balance is skewed extremely in the direction of beginner material and there is precious little material for advanced users. If you look at other branches of knowledge, say electronics, there is couple of books for beginners and then massive selection of highly specialized books for experts. I get that part of this is due to multitude of lang…

Another thing that bothers me is that most intermediary books on a topic tend to start with a good chunk of beginner stuff. For example, many game programming books will cover a ton of beginner material at the start, same with graphics books or books on a particular programming language. I shudder to think of how much duplicated content that I will never read because I'm no longer a beginner is sitting in my bookshelf. If I buy an intermediary or advanced book, I don't need a recap giving me the absolute basics! Eg if its an intermediate-level programming language book, don't tell me how to do simple conditionals or loops or something that I definitely already know to consider an intermediate-level book...

Re: How to write a programming book

#24
post #16

This would be interesting if I could read it. Would it be possible to display text without enabling JS? I have read several IT books recently and they aren't good. Basic stuff like visibility of diagrams, presenting advanced subject matter but also supposedly in a way that will teach you programming, or having pages of code to illustrate something trivial.

I'm working on that. I just used a stock template for the website.

The low contrast text is also really hard to read.

Re: How to write a programming book

#25
post #10

What pains me about programming books is that due to the market pressure the balance is skewed extremely in the direction of beginner material and there is precious little material for advanced users. If you look at other branches of knowledge, say electronics, there is couple of books for beginners and then massive selection of highly specialized books for experts. I get that part of this is due to multitude of lang…

[deleted]

Re: How to write a programming book

#26
post #11

Generally speaking, books as a format make no sense. I have seen the financial records for number of popular tech book authors — and numbers related to them having published, for example: products, services, consulting & speaker fees, etc. If the author is trying, they make way more money from the numbers related to them publishing than the book sales. If you like writing long form tech guides, do yourself and your a…

I love buying pre-releas books from Prag Prog (which isn't exactly the same but similar to what you described). Especially since things change so fast, if you have to wait for a finalized, published version of the book, it's usually outdated by the time it even hits the shelves (not entirely of course, but parts of it). If the author(s) publish pre-releases frequently, it can be a fantastic reference.

Re: How to write a programming book

#27
post #5

One thing that is constantly left out of books is challenging problems with solutions for the user to cement the new ideas they’ve learned in actual examples. It’s very easy to read along and nod your head but it’s very hard (at least for me) to incorporate my new skills without memorable hands on examples.

Gee, write a program using what you just learnt and see if it works. You want someone to tell you what program to write?! I assume it's a book for kids, or a school textbook, when I see exercises like that. I don't understand the demand that books not only tell you things, but tell you how to learn everything in them too.

Apologies, I really tried to make this not sound condescending!

Re: How to write a programming book

#28
post #9

I think the article is really general advice about (tech) writing, not about writing a programming book. There is very little if anything specific to programming itself, e.g. e.g. the types of code fragments you should use as examples. Also, apart from the line: > You can always ask feedback from people you trust to gain confidence there is no mention of getting someone to proofread or even copy edit the book. This w…

>there is no mention of getting someone to proofread or even copy edit the book. This would also seem really important for a programming book - e.g. to check that the examples work away from the author's dev environment. You're actually talking two different things. Someone needs to proofread/copyedit the book. Full stop. And, unless you have a partner or particularly close friend who will/can do a careful edit for y…

This is a much more useful comment than the OP.

Books need review - not just a few comments on the general concept, but line by line proofreading of the English, and fact checking of every single technical statement.

This is fundamental to the process. It's not an aspiration, it's part of the writing process - because often you'll be writing content while other content is being reviewed, and feedback from both can influence the rest.

Re: How to write a programming book

#29
post #11

Generally speaking, books as a format make no sense. I have seen the financial records for number of popular tech book authors — and numbers related to them having published, for example: products, services, consulting & speaker fees, etc. If the author is trying, they make way more money from the numbers related to them publishing than the book sales. If you like writing long form tech guides, do yourself and your a…

If you go for free and online anyways, then you can pursue more interesting formats like Quantum Country [0]. It seems to include a spaced repetition mechanism. I have yet to try it though.

[0] https://quantum.country/

Re: How to write a programming book

#30
post #10

What pains me about programming books is that due to the market pressure the balance is skewed extremely in the direction of beginner material and there is precious little material for advanced users. If you look at other branches of knowledge, say electronics, there is couple of books for beginners and then massive selection of highly specialized books for experts. I get that part of this is due to multitude of lang…

This is the exact problem that I am working on with my project https://fromtoschool.com. Where we write books and create courses that teach new programming languages and frameworks to experienced developers, using the languages and frameworks that you already know.

The style we use to teach is optimized for speed of learning and teaches this way using the 'constructivist' method. I expand on this learning style, and why it is so effective more in this post: https://fromtoschool.com/why-most-programming-tutorials-are-....

Post reply on HN