Slide 1

Slide 1 text

How documentation and open communication leads to better collaboration @isabelcmdcosta

Slide 2

Slide 2 text

Documentation Open Communication

Slide 3

Slide 3 text

Problem ● Developers often overlook documentation ● Lack of documentation in projects and teams ● Cross teams miscommunication

Slide 4

Slide 4 text

My theory ● documentation leads to a more productive and autonomous individual contributors ● accessible documentation and open communication makes for a more inclusive team

Slide 5

Slide 5 text

Reflecting...

Slide 6

Slide 6 text

Workplace ● In person or remote ● Fixed set of team members ● Direct reach to colleagues ● Not always transparent collaboration Open Source ● Full remote ● Diverse set of contributors ● No direct reach to individuals ● Open communication and collaboration

Slide 7

Slide 7 text

Bus factor “(...) the number of team members who, if run over by a bus, would put the project in jeopardy. (...)” source: https://deviq.com/bus-factor/

Slide 8

Slide 8 text

Challenges Writing good documentation it’s like art Outdated documentation How much is enough or too much

Slide 9

Slide 9 text

Effects of caring about this Autonomy Inclusive Productivity

Slide 10

Slide 10 text

How can I improve ● Provide clear descriptions in pull requests and issues ● Document important decisions ● Try to avoid private conversations ● Responsibility of everyone in the team ● Put yourself into other shoes

Slide 11

Slide 11 text

Thank you! Feel free to reach out! @isabelcmdcosta @isabelcosta isabelcosta.github.io