$30 off During Our Annual Pro Sale. View Details »

Technical Writing

Stefan Baumgartner
April 10, 2017
380

Technical Writing

My experiences in technical writing.

Stefan Baumgartner

April 10, 2017
Tweet

Transcript

  1. TECHNICAL
    WRITING

    View Slide

  2. TOC TOC
    WHO’S THERE?

    View Slide

  3. View Slide

  4. A TECHNICAL BOOK
    ALSO NEEDS A NARRATIVE

    View Slide

  5. View Slide

  6. GRUNT GULP
    BURP FART SNEEZE

    View Slide

  7. Stefan, wir überlegen ob wir von
    Grunt auf Gulp wechseln sollten…
    Ja, die Trends zeigen, dass mehr
    nach Gulp als Grunt gesucht wird,
    die Technologie wirkt
    zukunftsträchtiger….
    Und wir haben gerade gemerkt,
    dass wir schon ein Buch zu Grunt
    veröffentlichen ….
    Weiß nicht, ob das nötig ist, die
    Konzepte sind die gleichen, die
    Technologien sind ja eigentlich
    austauschbar
    Aha

    View Slide

  8. View Slide

  9. View Slide

  10. View Slide

  11. TO GET EXPERTISE
    UNDERSTAND THE OTHER’S PAIN

    View Slide

  12. View Slide

  13. YOU MUST STAY DRUNK ON WRITING
    SO REALITY CANNOT DESTROY YOU
    Ray Bradbury

    View Slide

  14. View Slide

  15. I LOVE DEADLINES!
    AND THE WHOOSHING NOISE THEY
    MAKE AS THEY GO BY
    Douglas Adams

    View Slide

  16. 0
    1,5
    3
    4,5
    6
    1 2 3 4 5 6 7 8 9 10
    WOCHENENDEN
    PRO KAPITEL

    View Slide

  17. 0
    0,75
    1,5
    2,25
    3
    Feb 15 Mar 15 Apr 15 Mai 15 Jun 15 Jul 15 Aug 15 Sep 15 Okt 15 Nov 15 Dez 15 Jan 16 Feb 16
    ZEITVERTEILUNG IM
    ERSTEN SCHREIBJAHR

    View Slide

  18. 0
    0,75
    1,5
    2,25
    3
    Feb 15 Mar 15 Apr 15 Mai 15 Jun 15 Jul 15 Aug 15 Sep 15 Okt 15 Nov 15 Dez 15 Jan 16 Feb 16
    ZEITVERTEILUNG IM
    ERSTEN SCHREIBJAHR
    Appendix A MEAP

    View Slide

  19. JUST IN TIME
    VS. ON DEMAND

    View Slide

  20. View Slide

  21. • Getting Started With Gulp
    • The building blocks of Gulp
    • Gulp command-line interface
    • The local Gulp installation
    • The Gulpfile and Gulp plugins
    • Streams and the virtual file system
    • Readable and Writeable Streams
    • Transforming Data
    • The Virtual File System
    • Streams in Gulp
    • Our First Gulpfile
    • Creating a JavaScript bundle: The script
    task
    • Doing Quality checks: The test task
    • Compiling Less: The styles task
    • Summary
    • Setting up Gulp
    • The building blocks of Gulp
    • The Gulp Command Line Interface
    • The local Gulp installation
    • Creating Gulpfiles
    • A Gulp "Hello World" task
    • Dealing with streams
    • Readable and writeable streams with Gulp
    • Handling tasks with Gulp plugins
    • Transforming data
    • Changing the file structure
    • Chaining plugins
    • Summary

    View Slide

  22. IN TECH
    NOBODY READS WHAT YOU WRITE

    View Slide

  23. View Slide

  24. View Slide

  25. View Slide

  26. View Slide

  27. View Slide

  28. View Slide

  29. View Slide

  30. View Slide

  31. The author’s choice of colours (pink!)
    and font highly made me doubt his
    professionalism.

    View Slide

  32. Step 0: Define key points
    Step 1: Draw images
    Step 2: Create headlines
    around images
    Step 3: Fill with code and text

    View Slide

  33. View Slide

  34. PLAN YOUR CHAPTER
    ASK THE RIGHT QUESTIONS

    View Slide

  35. BOOK and CHAPTER #:
    CHAPTER TITLE:
    WHY? WHO CARES?:
    PREREQUISITES:
    NEW SUPPORTING CONCEPTS:
    DIAGRAMS:
    EXAMPLES IN CHAPTER:
    TAKE-AWAYS:

    View Slide

  36. SELL BEFORE YOU FINISH
    MANNING’S EARLY ACCESS PROGRAM

    View Slide

  37. Stefan Baumgartner Stefan Baumgartner Stefan Baumgartner

    View Slide

  38. Hi Stephan …
    Hi Stephen
    Hi Candace…
    Best, Stefan
    Hi Candance
    Hi Steven
    I can dance
    Hi Steffen
    Hi Liz …

    View Slide

  39. View Slide

  40. View Slide

  41. View Slide

  42. GOING INTO
    PRODUCTION

    View Slide

  43. Gulpfile
    http://localhost:3000
    localhost:3000
    server
    Client
    3. Websocket connection
    2. Response with injection
    1. Request
    File system
    Serves files
    Notifies of change
    Watched by
    Your Gulpfile watches over changes in
    your file system. Once a change occurs,
    Gulp notifies the server that a change has
    happened. BrowserSync, knowing of the files
    it serves, swaps the new contents in through
    the established websocket connection. No
    reload is seen, just the new contents.
    The client (browser) requests files from
    your server. The response is modified by the
    addition of a new JavaScript file, injecting
    a websocket connection to the server.

    View Slide

  44. Insert a comma after Gulp. Second
    line write Gulp in capitals, change
    text to: “….”
    What do you refer to when speaking
    of the original Gulp task?
    OK
    OK

    View Slide

  45. View Slide

  46. View Slide

  47. 1. Writing takes a lot of time
    2. Create a narrative
    3. Just in time is better than on demand
    4. Draw, then write
    5. Let somebody proof-read
    6. Marketing…

    View Slide

  48. View Slide

  49. @ddprrt

    View Slide