The Failure story through writing the first technical book

Transcript

1. The Failure story through
   writing the first technical book
   kkeeth @kuwahara_jsri @clown0082
   Dec 21, 2020
   #ٕज़ॻք۾Λ੝Γ্͛Δձ
   

   View Slide

2. Jun 19, 2020
   

   View Slide

3. Published a Riot.js book
   

   View Slide

4. Published a Riot.js book
   Please buy it
   https://www.amazon.co.jp/gp/product/4863543115
   

   View Slide

5. View Slide

6. ...and my happy was for a moment
   

   View Slide

7. https://github.com/kkeeth/riot4-book-support/issues?q=is%3Aissue+is%3Aclosed
   

   View Slide

8. incoming many misspellings
   and typographical issues…
   

   View Slide

9. OMG !!
   

   View Slide

10. What was the problem?
    What was I supposed to do?
    

    View Slide

11. So, today I’d like to share
    some tips for writing
    technical books
    

    View Slide

12. Who am I ?
    

    View Slide

13. const my_info = {
    Workplace: ‘Yumemi Inc’,
    Position1: ‘Servant Leader of FET’,
    Position2: ‘Director’,
    Community: ‘Riot.js, Ionic, DIST’,
    PokemonGO: ‘TL40’
    }
    About me
    

    View Slide

14. npm/~kkeeth
    

    View Slide

15. 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!!
    

    View Slide

16. Analyze why this
    happened
    

    View Slide

17. ɾAbout writing env
    ɾWhat’s the stats ?
    Premise
    

    View Slide

18. My writing environment
    

    View Slide

19. https://docs.gitbook.com/
    main tool used
    

    View Slide

20. usage about gitbook-cli
    

    View Slide

21. usage about gitbook-cli
    build for static
    HTML files
    

    View Slide

22. my book sample
    

    View Slide

23. One problem comes up
    when I'm writing
    

    View Slide

24. I want to count the number of
    characters…
    

    View Slide

25. 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.
    

    View Slide

26. You just have to make it,
    someone said
    

    View Slide

27. https://www.npmjs.com/package/wcmd
    created tool
    

    View Slide

28. created tool
    single file
    multiple files
    

    View Slide

29. My writing stats
    

    View Slide

30. ɾmy book has 334 pages
    ɾ230734 characters
    ɾabout 2 months
    ɾmy book is sole author
    my writing stats
    

    View Slide

31. more details
    https://note.com/clown0082/n/n7549641e5a9e
    

    View Slide

32. ɾBug in product
    ɾNot enough time for review
    ɾTypographical errors
    ɹand misprints
    Problems
    

    View Slide

33. Cause of the problems
    

    View Slide

34. 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
    

    View Slide

35. Points:
    Make a firm plan and
    proceed steadily
    

    View Slide

36. Review
    & Fix
    Writing
    planning writing project
    Product
    Story
    

    View Slide

37. Review
    & Fix
    Writing
    planning writing project
    Product
    Story
    Books usually have a story
    (my book is too)
    

    View Slide

38. ɾ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
    

    View Slide

39. ɾ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
    

    View Slide

40. Review
    & Fix
    Writing
    planning writing project
    Product
    Story
    At first, we must
    get a review ❗
    Next, get a review
    as well ❗
    

    View Slide

41. Review
    & Fix
    Writing
    planning writing project
    Product
    Story
    There are several perspectives,
    especially here ✋
    

    View Slide

42. ɾTypos and errors
    ɾCapitalize the beginning of nouns
    ɾConcrete rather than abstract
    ɾAmbiguous expression
    ɾFormatting e.g. “Ͱ͢·͢”
    …etc
    

    View Slide

43. There is a wonderful tool
    for typos and errors
    

    View Slide

44. wonderful tool: textlint
    https://textlint.github.io/
    

    View Slide

45. Summary
    

    View Slide

46. ❖ Make products first (Code is written first)
    ❖ Set a firm schedule and proceed steadily
    ❖ As much time for review as possible
    

    View Slide

47. I hope you produce some
    great technical books!
    

    View Slide

48. Publicity
    

    View Slide

49. We’re hiring Lead members!!
    It’s a new
    logo
    

    View Slide

50. There are three funny system
    ‣ Unlimited paid holidays
    ‣ We all are CEO
    ‣ Salary is self-determined
    

    View Slide

51. View Slide

52. View Slide