Skip to content

Commit ab1d956

Browse files
authored
Merge pull request #88 from justwriteclick/practical-book
Practical book
2 parents 3a57766 + f0af77e commit ab1d956

6 files changed

Lines changed: 101 additions & 0 deletions

File tree

_posts/articles/2018-01-06-video-presentations-docs-like-code.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,5 @@ Even when I don't make it to the conference in person, the video recordings are
4747
{% include youtube.html id=page.youtubeIdRiona %}
4848

4949
All this to say, the docs-like-code concepts are widely practiced in our industry, and each conference provides more inspiring examples. Perhaps you can watch these presentations and be inspired to integrate code and doc techniques.
50+
51+
{% include sign-up.html %}

_posts/articles/2018-02-12-change-case-study.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,3 +247,6 @@ To read some other docs-as-code posts on my blog, see the following:
247247

248248
{: .tip}
249249
To Learn more about docs as code, see Anne Gentle's book [Docs Like Code](https://www.amazon.com/Docs-Like-Code-Anne-Gentle/dp/1365816079/ref=sr_1_1?ie=UTF8&qid=1508090523&sr=8-1&keywords=docs+like+code).
250+
251+
252+
{% include sign-up.html %}
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
layout: post
3+
title: "Practical Advice On Publishing A Technical Book using GitHub and GitBook"
4+
excerpt: What does it take to publish a technical book using GitHub? Let's dig into tools, processes, revenue, and costs.
5+
last_modified_at: Fri Apr 20 21:01:44 CDT 2018
6+
categories: articles
7+
author: anne_gentle
8+
tags: [book, publishing, github, git, gitbook, lulu, self-publishing, collaboration, design, layout]
9+
image:
10+
path: /images/designbyandren-lightbulb.jpg
11+
caption: "[Flickr designbyandren](https://flic.kr/p/cMiQAJ)"
12+
comments: false
13+
share: true
14+
---
15+
16+
What does it take to put together a web site, a book, an ebook, all for sale online? Let's look at costs for tools and services that make it happen.
17+
18+
Let’s look at what you need for a book idea. You need an audience, an editor, a way to reach that audience, and a “pitch” for the book idea itself. You may chose self-publishing over pitching the book idea to a technical book publisher.
19+
20+
In my recent experience with *Docs Like Code*, the process led me to choosing to produce the site, epub, and printed book all using tools I had prior experiences with. Let's take a look.
21+
22+
## Reaching out to current contacts
23+
24+
First, I reached out to Andy Oram, a senior editor at O'Reilly who knows me from a couple of open source projects, asking if he thought O'Reilly would want a book proposal. He said he'd be happy to read what I had, but didn't see the initial concept fitting into their current catalog. Really great of him to offer to help out, and I simply thanked him and kept going with my idea.
25+
26+
In parallel, I reached out to the publisher for my first book, *Conversation and Community*. His name is Richard Hamilton and he runs [XML Press](https://xmlpress.com). When he looked at his schedule,
27+
he couldn't read through at the draft copy for about 3 months. Well, I thought that the timing was essential, and I didn't want to wait that long, knowing both the market and my own availability.
28+
29+
## Finding like-minded collaborators
30+
31+
I also reached out to Diane Fleming, now Skwish, who had been teaching writers how to use Git and GitHub for docs over the same time as I had been. Over lunch, we realized we both wanted this book to be available for the next time we teach developers and writers how to write and review docs on GitHub. Diane is a talented writer and also a super editor. The best writers re-write a lot, and I knew Diane would provide an eagle eye for both technical accuracy as well as great writing.
32+
33+
Then, I realized I have a great friend in Kelly Holcomb, who edited my first book and I could talk her into editing this one, wahoo! Kelly also had experience in using GitHub for editing, so her contributions were super important for the final copy.
34+
35+
One area I did skip on for this book was a professional-level index, which Kelly was able to do for a great job on for *Conversation and Community*. I haven’t missed the index yet, and for a smaller book it seems like an index could look like padding.
36+
37+
## Design materials and promotional work
38+
39+
I also was able to do all the design imagery myself, including the book cover. This part was thanks to [Canva](https://www.canva.com/) and some nice templates that service has online. I used the free trial for Canva to make the book cover and stickers and [t-shirt](http://www.docslikecode.com/tshirt/) design.
40+
41+
That said, I was not willing to take on the layout work myself. So, when [Gitbook](https://www.gitbook.com/) did not output a PDF that I considered "print-ready", I went to [Upwork](https://www.upwork.com). I wanted more fine-tuned layout and design for the print copy, including proper page breaks and nice tables. So I hired a designer with access to Indesign who could take the epub and turn it into a print book.
42+
43+
## Pull it together!
44+
45+
And so, with all those bits of input from others, it created a quest to be a product manager for my own information product! I went that route, and for me, [Lulu](https://www.lulu.com/) was a tool I was already familiar with because we had done publishing with it for OpenStack.
46+
47+
There are other publishing options - IngramSpark, Amazon, LeanPub, and I’m sure others. I did sign up and get approved for an account with IngramSpark, which is the print-on-demand service that XML Press uses.
48+
49+
To me, after reading the [origin story for Lulu](http://www.lulu.com/about/our-story), I feel that Lulu is a bit more "open source" based than say, Amazon. I don't know much about LeanPub. Since I was using Markdown on a private GitHub repo anyway, it doesn't seem to offer more than Lulu for the marketplace reach. I'm not trying to make money at it; only trying to increase reach.
50+
51+
Finding a freelance editor would be a huge leg up on the writing process itself, especially if you also need a bit of developmental editing for the book idea.
52+
53+
For the print layout, I had a great experience with UpWork and was also able to keep the same person for work I needed one for the second edition. I learned from using a freelance site that I can find and manage freelancers for projects that I want to get done but don’t want to carve out time or buy tools for myself to finish them.
54+
55+
## List of tools and services
56+
57+
| Tools | Site |
58+
|-----------|------------------------------------------------------------------|
59+
| Calibre | [https://www.calibre-ebook.com/](https://www.calibre-ebook.com/) |
60+
| Canva | [https://www.canva.com/](https://www.canva.com/) |
61+
| GitBook | [https://www.gitbook.com/](https://www.gitbook.com/) |
62+
| GitHub | [https://www.github.com/](https://www.github.com/) |
63+
| Lulu | [https://www.lulu.com/](https://www.lulu.com/) |
64+
| Mailchimp | [https://www.mailchimp.com/](https://www.mailchimp.com/) |
65+
| Printful | [https://www.printful.com/](https://www.printful.com/) |
66+
| Shopify | [https://www.shopify.com/](https://www.shopify.com/) |
67+
| Upwork | [https://www.upwork.com/](https://www.upwork.com/) |
68+
69+
## Ongoing and startup costs
70+
71+
Here’s a high-level overview of the startup costs for creating a book like *Docs Like Code*.
72+
I calculated the starting costs for six or five months, when I needed a monthly subscription for a service.
73+
74+
| Service | Costs |
75+
|----------------------------|---------------------|
76+
| Domain name registration | $20/year |
77+
| GitHub for Private repo | $42 ($7/month x 6) |
78+
| GitBooks for Private repo | $35 ($7/month x 5) |
79+
| GitHub Pages for website | $0 |
80+
| Canva for Work (cover art) | $0 trial |
81+
| Lulu (printed copies) | $82 for 15 printed |
82+
| Editing/Writing | $250 celebration |
83+
| Design for PDF layout | $250 |
84+
| MailChimp (ongoing) | $42 ($7/month x 6) |
85+
| Twitter ads | $25 for ads |
86+
| Stickers | $82 for 200 |
87+
| **Total startup costs** | **$828** |
88+
89+
Based on Lulu reporting, I see the book brought in about $2500 in 12 months of the first and second edition being available. So while the startup costs are not nothing, I did see a profit from the effort. Really, though, the effort is paid off in helping others see the benefits I've observed and in sharing and learning. Let me know what you think about this method, the tools, and of course, the resulting book, *Docs Like Code*.
90+
91+
{% include sign-up.html %}

articles/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,6 @@ title: Articles
44
excerpt: "Read articles to learn more about the docs like code vision and how to try it for yourself."
55
search: false
66
---
7+
8+
9+
{% include sign-up.html %}
580 KB
Loading

tshirt/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,5 @@ last_modified_at: Sat May 13 08:39:50 CDT 2017
1111
---
1212

1313
Get <a href="http://just-write-click.myshopify.com/">t-shirts</a> now!
14+
15+
{% include sign-up.html %}

0 commit comments

Comments
 (0)