Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
The Failure story through writing the first tec...
Search
kkeeth
December 21, 2020
Technology
0
79
The Failure story through writing the first technical book
kkeeth
December 21, 2020
Tweet
Share
More Decks by kkeeth
See All by kkeeth
とある EM の初めての育休からの学び
clown0082
1
1.3k
The history of Javascript frameworks: changes in front-end design philosophy
clown0082
2
130
Visually experience the beauty of mathematics with p5.js
clown0082
1
2.8k
Rediscover the joy of coding with Creative Coding
clown0082
0
1.5k
全員が意思決定する会社で開発者体験や生産性を見る大変さについて
clown0082
0
570
JavaScript × Mathematics go to Digital Art
clown0082
1
340
In-house study group at YUMEMI
clown0082
0
180
Playing Ionic Logo by p5.js
clown0082
0
240
Skills that employers recommend students to acquire
clown0082
1
280
Other Decks in Technology
See All in Technology
コンピュータビジョンの社会実装について考えていたらゲームを作っていた話
takmin
1
470
ユーザーストーリーマッピングから始めるアジャイルチームと並走するQA / Starting QA with User Story Mapping
katawara
0
260
AndroidXR 開発ツールごとの できることできないこと
donabe3
0
130
わたしのOSS活動
kazupon
2
300
ESXi で仮想化した ARM 環境で LLM を動作させてみるぞ
unnowataru
0
130
PHPカンファレンス名古屋-テックリードの経験から学んだ設計の教訓
hayatokudou
2
500
ローカルLLMを活用したコード生成と、ローコード開発ツールへの応用
kazuhitoyokoi
0
130
OpenID Connect for Identity Assurance の概要と翻訳版のご紹介 / 20250219-BizDay17-OIDC4IDA-Intro
oidfj
0
370
SA Night #2 FinatextのSA思想/SA Night #2 Finatext session
satoshiimai
1
150
Goで作って学ぶWebSocket
ryuichi1208
3
2.3k
Cloud Spanner 導入で実現した快適な開発と運用について
colopl
1
890
脳波を用いた嗜好マッチングシステム
hokkey621
0
160
Featured
See All Featured
VelocityConf: Rendering Performance Case Studies
addyosmani
328
24k
Facilitating Awesome Meetings
lara
52
6.2k
jQuery: Nuts, Bolts and Bling
dougneiner
63
7.6k
ReactJS: Keep Simple. Everything can be a component!
pedronauck
666
120k
10 Git Anti Patterns You Should be Aware of
lemiorhan
PRO
656
59k
Code Reviewing Like a Champion
maltzj
521
39k
Java REST API Framework Comparison - PWX 2021
mraible
28
8.4k
Statistics for Hackers
jakevdp
797
220k
The Art of Programming - Codeland 2020
erikaheidi
53
13k
Chrome DevTools: State of the Union 2024 - Debugging React & Beyond
addyosmani
4
350
What's in a price? How to price your products and services
michaelherold
244
12k
The Myth of the Modular Monolith - Day 2 Keynote - Rails World 2024
eileencodes
21
2.5k
Transcript
The Failure story through writing the first technical book kkeeth
@kuwahara_jsri @clown0082 Dec 21, 2020 #ٕज़ॻք۾ΛΓ্͛Δձ
Jun 19, 2020
Published a Riot.js book
Published a Riot.js book Please buy it https://www.amazon.co.jp/gp/product/4863543115
None
...and my happy was for a moment
https://github.com/kkeeth/riot4-book-support/issues?q=is%3Aissue+is%3Aclosed
incoming many misspellings and typographical issues…
OMG !!
What was the problem? What was I supposed to do?
So, today I’d like to share some tips for writing
technical books
Who am I ?
const my_info = { Workplace: ‘Yumemi Inc’, Position1: ‘Servant Leader
of FET’, Position2: ‘Director’, Community: ‘Riot.js, Ionic, DIST’, PokemonGO: ‘TL40’ } About me
npm/~kkeeth
Sorry … This slide is made in English. But I
am unfamiliar using English. So, I may have a wrong expression. Plz feedback for me called “Masakari” about my English!!
Analyze why this happened
ɾAbout writing env ɾWhat’s the stats ? Premise
My writing environment
https://docs.gitbook.com/ main tool used
usage about gitbook-cli
usage about gitbook-cli build for static HTML files
my book sample
One problem comes up when I'm writing
I want to count the number of characters…
I want to count the number of characters… Because books
are usually about 1,400 characters per page. It takes about 200,000 characters to write a whole technical book.
You just have to make it, someone said
https://www.npmjs.com/package/wcmd created tool
created tool single file multiple files
My writing stats
ɾmy book has 334 pages ɾ230734 characters ɾabout 2 months
ɾmy book is sole author my writing stats
more details https://note.com/clown0082/n/n7549641e5a9e
ɾBug in product ɾNot enough time for review ɾTypographical errors
ɹand misprints Problems
Cause of the problems
writing and development at the same time Began in earnest
2 months before the deadline Brushing up or change the product while writing MY BAD CASES I've stretched the schedule for drafts twice
Points: Make a firm plan and proceed steadily
Review & Fix Writing planning writing project Product Story
Review & Fix Writing planning writing project Product Story Books
usually have a story (my book is too)
ɾCHAPTER 01 Riot.jsʹ͍ͭͯΖ͏ ɾCHAPTER 02 Riot.jsͷجૅ ɾCHAPTER 03 ͡ΊͯͷRiot.jsͰͷΞϓϦέʔγϣϯ։ൃ ɾCHAPTER
04 Giphy APIΛར༻ͨ͠ΞϓϦέʔγϣϯ ɾCHAPTER 05 Riot.jsͰͷελΠϦϯά ɾCHAPTER 06 CMSͷ։ൃ my book index
ɾCHAPTER 01 Riot.jsʹ͍ͭͯΖ͏ ɾCHAPTER 02 Riot.jsͷجૅ ɾCHAPTER 03 ͡ΊͯͷRiot.jsͰͷΞϓϦέʔγϣϯ։ൃ ɾCHAPTER
04 Giphy APIΛར༻ͨ͠ΞϓϦέʔγϣϯ ɾCHAPTER 05 Riot.jsͰͷελΠϦϯά ɾCHAPTER 06 CMSͷ։ൃ my book index intro Practice Basis
Review & Fix Writing planning writing project Product Story At
first, we must get a review ❗ Next, get a review as well ❗
Review & Fix Writing planning writing project Product Story There
are several perspectives, especially here ✋
ɾTypos and errors ɾCapitalize the beginning of nouns ɾConcrete rather
than abstract ɾAmbiguous expression ɾFormatting e.g. “Ͱ͢·͢” …etc
There is a wonderful tool for typos and errors
wonderful tool: textlint https://textlint.github.io/
Summary
❖ Make products first (Code is written first) ❖ Set
a firm schedule and proceed steadily ❖ As much time for review as possible
I hope you produce some great technical books!
Publicity
We’re hiring Lead members!! It’s a new logo
There are three funny system ‣ Unlimited paid holidays ‣
We all are CEO ‣ Salary is self-determined
None
None