Move Fast And Document Things

Download Move Fast And Document Things

Post on 14-Apr-2017

69 views

Category:

Software

0 download

Embed Size (px)

TRANSCRIPT

<ul><li><p>M O V E FA S T A N D D O C U M E N T T H I N G SS T R A T E G I E S F O R W R I T I N G I N T E R N A L D O C S A T FA S T- M O V I N G O R G A N I Z A T I O N S</p><p>R U T H I E B E N D O R @ U N R U T H L E S S</p></li><li><p>@ U N R U T H L E S S</p></li><li><p>@ U N R U T H L E S S</p><p>E X T E R N A L T E C H N I C A L D O C S</p></li><li><p>@ U N R U T H L E S S</p><p>E X T E R N A L T E C H N I C A L D O C S</p><p>A P I R E F E R E N C E ! H O W - T O G U I D E S ! S A M P L E A P P S !</p><p>FA Q S ! D E V E L O P E R D O C S ! S D K S !</p></li><li><p>@ U N R U T H L E S Scredit: https://www.flickr.com/photos/skylarprimm/9385954331</p><p>I N T E R N A L T E C H N I C A L D O C S</p></li><li><p>@ U N R U T H L E S Scredit: https://www.flickr.com/photos/skylarprimm/9385954331</p><p>I N T E R N A L T E C H N I C A L D O C S</p><p>R E A D M E S ! U P T I M E D O C S ! W I K I PA G E S !</p><p>E M A I L S ! P O S T- I T S ! C O L L E A G U E S B R A I N !</p></li><li><p>T H E M AT E R I A L S W E C R E AT E F O R O U R C O L L E A G U E S A N D F O R O U R F U T U R E S E LV E S ! </p><p>T H AT E N A B L E U S T O B U I L D U P O N O U R W O R K .</p><p>@ U N R U T H L E S S</p><p>I N T E R N A L T E C H N I C A L D O C S :</p></li><li><p>@ U N R U T H L E S S</p></li><li><p>@ U N R U T H L E S S</p></li><li><p>@ U N R U T H L E S S</p></li><li><p>@ U N R U T H L E S S</p></li><li><p> S L O W - M O V I N G N O N P R O F I T</p><p>We care about internal technical docs because they help us make our software last as long as possible. </p><p>@ U N R U T H L E S S</p></li><li><p>@ U N R U T H L E S S</p><p>A N D N O W, F O R S O M E T H I N G </p><p>C O M P L E T E LY D I F F E R E N T</p></li><li><p>@ U N R U T H L E S S</p></li><li><p> A G E N C Y</p><p>We care about internal technical docs because actually, we dont. </p><p>@ U N R U T H L E S S</p></li><li><p>@ U N R U T H L E S S</p></li><li><p> S TA R T U P</p><p>We care about internal technical docs because they help us onboard new staff. </p><p>@ U N R U T H L E S S</p></li><li><p>C O M PA N Y</p><p>C O M PA N Y</p><p>@ U N R U T H L E S S</p></li><li><p>@ U N R U T H L E S S</p></li><li><p>B O S S</p><p>B O S S</p><p>B O S S &lt; B O S S @ C O M PA N Y. C O M &gt;</p><p>C O M PA N Y</p><p>@ U N R U T H L E S S</p><p>mailto:boss@company.com?subject=</p></li><li><p>B O S S &lt; B O S S @ C O M PA N Y. C O M &gt;</p><p>C O M PA N Y</p><p>C O M PA N Y</p><p>C O M PA N Y</p><p>@ U N R U T H L E S S</p><p>mailto:boss@company.com?subject=</p></li><li><p>C O M PA N Y P R O D U C T</p><p>P R O D U C T</p><p>@ U N R U T H L E S S</p></li><li><p>C O M PA N Y P R O D U C T</p><p>P R O D U C T</p><p>@ U N R U T H L E S S</p><p># S TA R T U P LY F E</p></li><li><p>$ git checkout 56a4e5c08Note: checking out '56a4e5c08'.</p><p>You are in 'detached HEAD' state</p><p>$ _</p><p>@ U N R U T H L E S S</p></li><li><p>H O W T O W R I T E I N T E R N A L D O C S AT FA S T- M O V I N G O R G A N I Z AT I O N S</p><p>@ U N R U T H L E S S</p><p>in four simple steps</p></li><li><p>F I G U R E O U T W H AT S B R O K E N .</p><p>S T E P 1 :</p><p>@ U N R U T H L E S S</p></li><li><p> 100% Pre-Commit Code Review! </p><p> Continuous Integration! </p><p> Monitoring! </p><p> No deploys on Fridays past 4pm!</p><p>@ U N R U T H L E S S</p><p>T H I N G S T H AT W E R E N O T B R O K E N</p></li><li><p> Amazing Colleagues!</p><p>@ U N R U T H L E S S</p><p>T H I N G S T H AT W E R E N O T B R O K E N</p></li><li><p>T H I N G S T H AT W E R E B R O K E N</p><p> Belief that internal technical docs depreciate in value too quickly</p><p>R U T H I E B E N D O R @ U N R U T H L E S S</p></li><li><p>T H I N G S T H AT W E R E B R O K E N</p><p> Belief that internal technical docs depreciate in value too quickly </p><p> Presumption of homogenous technical backgrounds </p><p> Presumption of institutional knowledge</p><p>R U T H I E B E N D O R @ U N R U T H L E S S</p></li><li><p>T H I N G S T H AT W E R E B R O K E N</p><p> Belief that internal technical docs depreciate in value too quickly </p><p> Presumption of homogenous technical backgrounds </p><p> Presumption of institutional knowledge </p><p> No unambiguousright way to write internal docs</p><p>@ U N R U T H L E S S</p></li><li><p>F I G U R E O U T W H AT S B R O K E N .</p><p>S T E P 1 :</p><p>@ U N R U T H L E S S</p></li><li><p>F I G U R E O U T W H Y Y O U R O R G A N I Z AT I O N W I L L C A R E A B O U T F I X I N G I T.</p><p>S T E P 2 : </p><p>@ U N R U T H L E S S</p></li><li><p> S L O W - M O V I N G N O N P R O F I T</p><p>We care about internal technical docs because they help us make our software last as long as possible. </p><p>@ U N R U T H L E S S</p></li><li><p> S TA R T U P</p><p>We care about internal technical docs because they help us onboard new staff. </p><p>@ U N R U T H L E S S</p></li><li><p> S TA R T U P</p><p>We care about internal technical docs because they increase bus factor. </p><p>@ U N R U T H L E S S</p></li><li><p> S TA R T U P</p><p>We care about internal technical docs because they increase bus factor. </p><p>@ U N R U T H L E S S</p></li><li><p> S TA R T U P</p><p>We care about internal technical docs because ________. </p><p>@ U N R U T H L E S S</p></li><li><p> S TA R T U P</p><p>We care about internal technical docs because we value learning from each other. </p><p>@ U N R U T H L E S S</p></li><li><p>F I G U R E O U T W H Y Y O U R O R G A N I Z AT I O N W I L L C A R E A B O U T F I X I N G I T.</p><p>S T E P 2 : </p><p>@ U N R U T H L E S S</p></li><li><p>C O U C H Y O U R S O L U T I O N S I N T H E O R G A N I Z AT I O N S VA L U E S .</p><p>S T E P 3 :</p><p>@ U N R U T H L E S S</p></li><li><p>AT E V E R Y I N F L E C T I O N P O I N T, R E E VA L U AT E , R I N S E , R E P E AT.</p><p>S T E P 4 :</p><p>@ U N R U T H L E S S</p></li><li><p>T H A N K S !C O M E S A Y H I ! </p><p>I M R U T H I E B E N D O R . </p><p>S L A C K + T W I T T E R : @ U N R U T H L E S S </p><p>E M A I L : R U T H I E @ U N R U T H L E S S . C O M</p></li></ul>