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
The history of Javascript frameworks: changes in front-end design philosophy
clown0082
2
99
Visually experience the beauty of mathematics with p5.js
clown0082
1
2.7k
Rediscover the joy of coding with Creative Coding
clown0082
0
1.3k
全員が意思決定する会社で開発者体験や生産性を見る大変さについて
clown0082
0
550
JavaScript × Mathematics go to Digital Art
clown0082
1
310
In-house study group at YUMEMI
clown0082
0
160
Playing Ionic Logo by p5.js
clown0082
0
210
Skills that employers recommend students to acquire
clown0082
1
260
Walking through the source code of an OSS Library(ESLint))
clown0082
0
350
Other Decks in Technology
See All in Technology
VideoMamba: State Space Model for Efficient Video Understanding
chou500
0
190
リンクアンドモチベーション ソフトウェアエンジニア向け紹介資料 / Introduction to Link and Motivation for Software Engineers
lmi
4
300k
Why does continuous profiling matter to developers? #appdevelopercon
salaboy
0
190
これまでの計測・開発・デプロイ方法全部見せます! / Findy ISUCON 2024-11-14
tohutohu
3
370
インフラとバックエンドとフロントエンドをくまなく調べて遅いアプリを早くした件
tubone24
1
430
テストコード品質を高めるためにMutation Testingライブラリ・Strykerを実戦導入してみた話
ysknsid25
7
2.6k
OCI Network Firewall 概要
oracle4engineer
PRO
0
4.1k
Amplify Gen2 Deep Dive / バックエンドの型をいかにしてフロントエンドへ伝えるか #TSKaigi #TSKaigiKansai #AWSAmplifyJP
tacck
PRO
0
380
複雑なState管理からの脱却
sansantech
PRO
1
140
マルチモーダル / AI Agent / LLMOps 3つの技術トレンドで理解するLLMの今後の展望
hirosatogamo
37
12k
OCI Security サービス 概要
oracle4engineer
PRO
0
6.5k
【Startup CTO of the Year 2024 / Audience Award】アセンド取締役CTO 丹羽健
niwatakeru
0
990
Featured
See All Featured
Faster Mobile Websites
deanohume
305
30k
Bootstrapping a Software Product
garrettdimon
PRO
305
110k
Performance Is Good for Brains [We Love Speed 2024]
tammyeverts
6
410
The Web Performance Landscape in 2024 [PerfNow 2024]
tammyeverts
0
89
jQuery: Nuts, Bolts and Bling
dougneiner
61
7.5k
Side Projects
sachag
452
42k
StorybookのUI Testing Handbookを読んだ
zakiyama
27
5.3k
The Power of CSS Pseudo Elements
geoffreycrofte
73
5.3k
Easily Structure & Communicate Ideas using Wireframe
afnizarnur
191
16k
[RailsConf 2023 Opening Keynote] The Magic of Rails
eileencodes
28
9.1k
Gamification - CAS2011
davidbonilla
80
5k
Raft: Consensus for Rubyists
vanstee
136
6.6k
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