Tweet
Tweet

Slide 1

Slide 1 text

@fmendes6

Slide 2

Slide 2 text

“The resistance to documentation among developers is well known and needs no emphasis.” - D.Herbsleb & D. Moitra, 
 Global Software Development, IEEE, 2001

Slide 3

Slide 3 text

Have you ever needed some form of information from someone that was unavailable?

Slide 4

Slide 4 text

What is this system? How does it work? Why was it created this way?

Slide 5

Slide 5 text

2017

Slide 6

Slide 6 text

Mar ‘18

Slide 7

Slide 7 text

A vailable
 Documentation

Slide 8

Slide 8 text

Detailed Jira tickets, user stories, regression suites, glossaries, etc.

Slide 9

Slide 9 text

Documentation
 Android team

Slide 10

Slide 10 text

No content

Slide 11

Slide 11 text

Problem 1 Lack of knowledge 
 about the app

Slide 12

Slide 12 text

Filipe, can you look at ticket X?

Slide 13

Slide 13 text

Hum…suuuure!

Slide 14

Slide 14 text

…

Slide 15

Slide 15 text

Ask And Continue Do not Ask and Continue Quit

Slide 16

Slide 16 text

I’m sorry, can you please help me?

Slide 17

Slide 17 text

What if your colleagues 
 are unavailable?

Slide 18

Slide 18 text

A dependency is a 
 problem if it blocks you 
 from progressing

Slide 19

Slide 19 text

Wiki

Slide 20

Slide 20 text

No content

Slide 21

Slide 21 text

“Just finished, now what?”

Slide 22

Slide 22 text

Different people use different tools, have different backgrounds 
 and ways to work.

Slide 23

Slide 23 text

No content

Slide 24

Slide 24 text

Wiki Overall architecture of our system URLs to external services and 3rd-party libraries Development process and how to setup all the tools

Slide 25

Slide 25 text

Apr ‘18

Slide 26

Slide 26 text

Problem 2 No process for 
 tech planning

Slide 27

Slide 27 text

Filipe, can you look at ticket X?

Slide 28

Slide 28 text

Sure!

Slide 29

Slide 29 text

I don’t like this approach..

Slide 30

Slide 30 text

There is an easier way to do that!

Slide 31

Slide 31 text

But I’ve just spent 2 days…

Slide 32

Slide 32 text

Request for Comments

Slide 33

Slide 33 text

No content

Slide 34

Slide 34 text

Code
 Review Start
 Feature Merge
 Feature Implementation phase

Slide 35

Slide 35 text

Create
 RFC RFC
 Approved Merge
 RFC Merge
 Feature Code
 Review Start
 Feature Implementation phase Design phase

Slide 36

Slide 36 text

No content

Slide 37

Slide 37 text

No content

Slide 38

Slide 38 text

No content

Slide 39

Slide 39 text

Request for Comments Fosters discussion within the team Serves as a historical report Newcomers can learn from previous colleagues

Slide 40

Slide 40 text

Jun ‘18

Slide 41

Slide 41 text

Jul ‘18

Slide 42

Slide 42 text

Problem 3 Lack of information about past incidents

Slide 43

Slide 43 text

All of us had incidents in production or bugs 
 that lasted for a while

Slide 44

Slide 44 text

In teams that change frequently, information and learnt lessons get lost

Slide 45

Slide 45 text

The past years are a blackbox for me.

Slide 46

Slide 46 text

We will be destined to make the same mistakes if we don’t know what happened.

Slide 47

Slide 47 text

…even though the client expects that you know.

Slide 48

Slide 48 text

Postmortem

Slide 49

Slide 49 text

No content

Slide 50

Slide 50 text

Postmortem Clarifies and documents what happened Can potentially be shared with the management team or even the client Your future colleagues can learn from past mistakes

Slide 51

Slide 51 text

Dec ‘18

Slide 52

Slide 52 text

Problem 4 Pull Requests with 
 no description

Slide 53

Slide 53 text

In a mobile application, a simple change can have a big UI impact

Slide 54

Slide 54 text

Descriptive Pull Requests

Slide 55

Slide 55 text

No content

Slide 56

Slide 56 text

Mar ‘19

Slide 57

Slide 57 text

New team means new dynamics

Slide 58

Slide 58 text

I prefer to discuss face to face

Slide 59

Slide 59 text

Results Saved my future self countless times Wrote reports of problems we had in production Documented processes, architectures, integrations etc.

Slide 60

Slide 60 text

My first month Need to mental-map the interactions..

Slide 61

Slide 61 text

Colleague’s first Month Yes, it was easy to pick-up!

Slide 62

Slide 62 text

Colleague’s first Month YAY, first time in 3 years that it was easy!

Slide 63

Slide 63 text

Former colleague’s 
 last week Wish we had RFCs when I started

Slide 64

Slide 64 text

Former colleague’s 
 last week It would’ve prevent a few discussions

Slide 65

Slide 65 text

We do a great job if our team is not dependent on us

Slide 66

Slide 66 text

Documentation is for the team/project, not the individuals

Slide 67

Slide 67 text

Slowly introduce documentation in your team

Slide 68

Slide 68 text

I have an RFC for you to review

Slide 69

Slide 69 text

Im writing a Doc for the Redesign

Slide 70

Slide 70 text

Thank him, it’s been very useful! ?

Slide 71

Slide 71 text

No content

Slide 72

Slide 72 text

Thank you Filipe Mendes @fmendes6
 medium.com/@fmendes6

Slide 73

Slide 73 text

References https://buriti.ca/6-lessons-i-learned-while-implementing- technical-rfcs-as-a-management- tool-34687dbf46cb, Juan Buriticá (2017) https://github.com/rust-lang/rfcs, Rust Language https://csse.usc.edu/events/2002/arr/letters.pdf, Manifesto Elicits Cynicism, Steven Rakitin (2002) https://ieeexplore.ieee.org/document/914732, J.D. Herbsleb, D. Moitra (2001) https://zeldauniverse.net/media/fonts, Zelda Universe https://proandroiddev.com/perfecting-process-for-presenting-prs-7b3c63cd2848, Perfecting process for Presenting PRs, Ataul Munim (2019) https://www.youtube.com/watch?v=xSlqpsdBQx4, Game Over - Zelda, PenguinIceNinja (2007) https://www.candyspace.com/team/, Candyspace (2019) https://github.com/novoda/novoda/blob/master/.github/PULL_REQUEST_TEMPLATE.md, Novoda (2017)