Technical Writing

187d92c9284160ad908885ab096f5209?s=47 Stefan Baumgartner
April 10, 2017
180

Technical Writing

My experiences in technical writing.

187d92c9284160ad908885ab096f5209?s=128

Stefan Baumgartner

April 10, 2017
Tweet

Transcript

  1. TECHNICAL WRITING

  2. TOC TOC WHO’S THERE?

  3. None
  4. A TECHNICAL BOOK ALSO NEEDS A NARRATIVE

  5. None
  6. GRUNT GULP BURP FART SNEEZE

  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
  8. None
  9. None
  10. None
  11. TO GET EXPERTISE UNDERSTAND THE OTHER’S PAIN

  12. None
  13. YOU MUST STAY DRUNK ON WRITING SO REALITY CANNOT DESTROY

    YOU Ray Bradbury
  14. None
  15. I LOVE DEADLINES! AND THE WHOOSHING NOISE THEY MAKE AS

    THEY GO BY Douglas Adams
  16. 0 1,5 3 4,5 6 1 2 3 4 5

    6 7 8 9 10 WOCHENENDEN PRO KAPITEL
  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
  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
  19. JUST IN TIME VS. ON DEMAND

  20. None
  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
  22. IN TECH NOBODY READS WHAT YOU WRITE

  23. None
  24. None
  25. None
  26. None
  27. None
  28. None
  29. None
  30. None
  31. The author’s choice of colours (pink!) and font highly made

    me doubt his professionalism.
  32. Step 0: Define key points Step 1: Draw images Step

    2: Create headlines around images Step 3: Fill with code and text
  33. None
  34. PLAN YOUR CHAPTER ASK THE RIGHT QUESTIONS

  35. BOOK and CHAPTER #: CHAPTER TITLE: WHY? WHO CARES?: PREREQUISITES:

    NEW SUPPORTING CONCEPTS: DIAGRAMS: EXAMPLES IN CHAPTER: TAKE-AWAYS:
  36. SELL BEFORE YOU FINISH MANNING’S EARLY ACCESS PROGRAM

  37. Stefan Baumgartner Stefan Baumgartner Stefan Baumgartner

  38. Hi Stephan … Hi Stephen Hi Candace… Best, Stefan Hi

    Candance Hi Steven I can dance Hi Steffen Hi Liz …
  39. None
  40. None
  41. None
  42. GOING INTO PRODUCTION

  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.
  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
  45. None
  46. None
  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…
  48. None
  49. @ddprrt