Feedback about writing a technical book
Interested about building and API using Ruby on Rails?
Early this year I was contacted by Developpez.com to find people to write articles. So I answered to participate on the subject of the Ruby on Rails framework.
I was asked to translate part of Abraham Kuri Vargas’s book APIs on Rails Building REST APIs with Rails. This book is a large tutorial of more than 200 pages to build a scalable API with Ruby on Rails following best practices.
I thought it could be a good experience so I started.
The project was not maintained and the version of the framework studied was obsolete. Examples were therefore no longer valid and had to be repeated. The mess. I tried to contact the author but to no response.
So I started to rewriting the book from scratch. As long as I was rewriting, I thought about translate it into Molière’s language.
Here is my feedback on the writing of a book of more than 200 pages in English and French.
How to write a book?
If you want to write a book, know that it’s a timeless thing. So I made sure it took me as little time as possible. I don’t pretend to have the best solution. This is just mine.
For the writing I wanted a system that would allow me to version my work and that it could include pieces of code. A lot of code pieces.
So I first turned to LaTeX which proved to be too rigid. My main problem was to have good syntax highlighting. Some solutions exist but they are still quite limited.
So I turned to the Markdown format with the Pandoc tool. This tool is absolutely brilliant but I ended up facing the same problems as with LaTeX since Pandoc relies on a conversion to LaTeX and then the conversion to PDF.
And then I discovered Asciidoctor. This is a syntax that provides additional features to the Markdown such as file management, footnotes, internal notes, comments and so on. In short, it’s the Markdown syntax with the power of LaTeX. It also allowed me to export my book in PDF, EPUB and MOBI easily and to customize the theme of my book.
To write, all you need is a classic text editor like VSCode, Atom or even a Notebook on Windows. For the versioning I use Git and I publish on Github .
The workflow I followed was as follows:
- redo the code examples on my side in a separate Github project
- rework the English version according to the changes I had just made
- paste the English version into a file
- make translations in copy/paste mode in Deepl
- correct the translation (because it is far from perfect)
- paste the French version into a file
The first problem I encountered was managing this whole process that involves writing the book in English and French. Adding the management of the project created throughout this book it was difficult. Looking back I should have left everything in English and maybe translated at the end.
Then I fixed myself:
- two rewriting per chapter in which I wrote quite quickly
- two reviews per chapter (including one from my girlfriend who helped me a lot)
- a promotion part (I will talk about it later)
The workflow of publishing articles on développez.com seemed really complicated to use and discouraged me. So I thought I would make it Open Source on Github, quoting of course the original work.
I was really surprised by the help of the open source community. Here are the figures of the Github project.
- 8 contributors
- 17 pull requests
- 92 stars
- 21 fork
I received pull requests that corrected syntax errors, broken links and questionable formulations. I also received s and bad feedback. For an anecdote, I was even contacted by a Russian who was interested in translating the book. He just needed to forge the project and create a
ru folder. That’s great.
Open source really gives the feeling that the book is alive.
When the book is finished or I have fixed things, I do a release on Github and attach the PDF, EPUB and MOBI files. So anyone can read it free of charge on the support of his choice.
Publication of the book
I thought that as long as I had to do, I would publish the book. It gave me visibility and also allowed me to get some money back.
I looked a little bit at Amazon but it seemed more complicated to me to create an account, choose the right tax and publish. Commissions are also much higher. So I gave up quickly, too bad for good old Jeff.
I chose Leanpub for its ease and also the fact that the price can be free.
So I published a total of 4 versions:
- one English version and one French version for Ruby on Rails 5
- one English version and one French version for Ruby on Rails 6
In the end, here are all the royalty figures, i.e. what goes in my pocket after the Leanpub commissions.
|API on Rails 5 (EN)||$160.63|
|API on Rails 5 (FR)||$15.98|
|API on Rails 6 (EN)||$473.22|
|API on Rails 6 (FR)||$20.78|
I was really surprised to sell “so much”. These figures really motivate me to keep the project going.
The figures are also to be put into context. It took a lot of work on my part, which is difficult to quantify. From the nose I would say between 500 and 1000 hours. This gives an hourly wage of $1.34 / hour**. So yes, clearly I’m not doing this for the money. But it was for me plus an excellent **paid experience**.
We also see that the English version sells 17 times better than the French version. The first sad conclusion I can give is that you have to translate your book into Shakespeare’s language.
Once the book is finished, the promotion begins. It’s a pretty foreign part for me and I did a little bit of a feeling. So I just talked on specialized social networks. That is to say:
- Hacker New which is a very demanding community where I have had very little feedback
- Le journal du Hacker which is a French community and therefore much smaller
- Reddit, which is the most active community where I have had the most feedback
In conclusion I think I made the mistake of wanting to go too fast because I started this promoting when my book had small spelling mistakes and syntax errors. The specialized community (in particular Hacker News) is quite uncompromising on this. I have had some negative feedback but also some excellent feedback by email which are very rewarding.
On the other hand, it was an exceptional experience that gave me a lot of personal satisfaction. This project also allowed me to set foot in open source and maintain a small project.