Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Technical Writing

Technical Writing

I was invited to speak to the Access Code classes at C4Q about writing technical blog posts.

Built with Spectacle [0] and hosted here [1].

[0]: https://github.com/FormidableLabs/spectacle
[1]: http://technical-writing.surge.sh/

3f8f51e1aa14cdd87cffeaa26bb0ce13?s=128

Eddie Zaneski

July 09, 2015
Tweet

Transcript

  1. Technical Writing @eddiezane @sendgrid doesnotscale.com

  2. English Class? I Hated It I Actually Hate Writing

  3. Why Do It?

  4. Content Is Your Legacy

  5. Nothing You Write Is Permanent Showcase How You've Grown

  6. Let Your True Self Shine Through

  7. Simple As Possible, Complex As Necessary - Sean Kilgore

  8. What's The Takeaway?

  9. Provide Just Enough Background

  10. Share Knowledge, Not Features - Adam DuVander

  11. Enlighten With Your Journey

  12. Educate With Your Failures

  13. Don't Forget The Why

  14. Show The Code But Cut The Crap

  15. p a c k a g e c o m

    . e d d i e z a n e . h e l l o a n d r o i d ; i m p o r t a n d r o i d . a p p . A c t i v i t y ; i m p o r t a n d r o i d . c o n t e n t . C o n t e x t ; i m p o r t a n d r o i d . c o n t e n t . S h a r e d P r e f e r e n c e s ; i m p o r t a n d r o i d . o s . B u n d l e ; i m p o r t a n d r o i d . v i e w . M e n u ; i m p o r t a n d r o i d . v i e w . M e n u I t e m ; i m p o r t a n d r o i d . v i e w . V i e w ; i m p o r t a n d r o i d . w i d g e t . B u t t o n ; i m p o r t a n d r o i d . w i d g e t . E d i t T e x t ; i m p o r t a n d r o i d . w i d g e t . T o a s t ; p u b l i c c l a s s P r e f S e t A c t i v i t y e x t e n d s A c t i v i t y { p r i v a t e B u t t o n b u t t o n ; p r i v a t e E d i t T e x t n a m e B o x ; @ O v e r r i d e p r o t e c t e d v o i d o n C r e a t e ( B u n d l e s a v e d I n s t a n c e S t a t e ) { s u p e r . o n C r e a t e ( s a v e d I n s t a n c e S t a t e ) ; s e t C o n t e n t V i e w ( R . l a y o u t . a c t i v i t y _ p r e f _ s e t ) ; n a m e B o x = ( E d i t T e x t ) f i n d V i e w B y I d ( R . i d . e d i t T e x t ) ; b u t t o n = ( B u t t o n ) f i n d V i e w B y I d ( R . i d . b u t t o n 2 ) ; f i n a l S h a r e d P r e f e r e n c e s p r e f s = g e t A p p l i c a t i o n C o n t e x t ( ) . g e t S h a r e d P r e f e r e n c e s ( " M A I N " , C o n t e x t . M O D E _ P R I V A T E ) ; b u t t o n . s e t O n C l i c k L i s t e n e r ( n e w V i e w . O n C l i c k L i s t e n e r ( ) { @ O v e r r i d e p u b l i c v o i d o n C l i c k ( V i e w v ) { p r e f s . e d i t ( ) . p u t S t r i n g ( " n a m e " , n a m e B o x . g e t T e x t ( ) . t o S t r i n g ( ) ) . c o m m i t ( ) ; T o a s t . m a k e T e x t ( g e t A p p l i c a t i o n C o n t e x t ( ) , " Y o , " + p r e f s . g e t S t r i n g ( " n a m e " , " D E F A U L T " ) , T o a s t . L E N G T H _ S H O R T ) . s h o w ( ) ; n a m e B o x . s e t T e x t ( p r e f s . g e t S t r i n g ( " n a m e " , n u l l ) ) ; } } ) ; i f ( p r e f s . g e t S t r i n g ( " n a m e " , n u l l ) ! = n u l l ) { n a m e B o x . s e t T e x t ( p r e f s . g e t S t r i n g ( " n a m e " , n u l l ) ) ; } } }
  16. Odd Tips Avoid Multi Part Posts Line By Line Explanations

    Work Sometimes Write About Things You Can't Find
  17. Examples

  18. Thanks! Questions? @eddiezane