Hosted by
Elixir Montréal
Wednesday, December 18th
6:00PM to 7:30PM EST
Online
Link available to attendees
Ready to join in on the fun?
Let's chat on Discord.
Join the event at 6 PM EST.
The talk will start around 6:15 and we should close before 7:30.
Gordon Guthrie has been an Erlang programmer since 2002 and an Elixir one for quite a bit less.
Presentations
Gordon Guthrie
In a world of dependencies and online package management, documentation tools are designed and optimised around the question "how do I use your library?".
But for companies that build systems to do something, and not libraries, there is another critical question "how does the system work? how can I change it?"
Library-based documentation is inline with the code and under the same version control system.
All too often architectural documentation is outside the code and poorly kept in sync.
This talk will look at another way of thinking about documenting systems a way that keeps architectural docs in the github repo and which plays nice with ExDoc.
Gordon Guthrie has been an Erlang programmer since 2002 and an Elixir one for quite a bit less.
Ready to join in on the fun?
Hosted by
Elixir Montréal
Dec
18
Wednesday, December 18th
6:00PM to 7:30PM EST
Online
Link available to attendees
Let's chat on Discord.
Join the event at 6 PM EST.
The talk will start around 6:15 and we should close before 7:30.
Gordon Guthrie has been an Erlang programmer since 2002 and an Elixir one for quite a bit less.
Presentations
Gordon Guthrie
In a world of dependencies and online package management, documentation tools are designed and optimised around the question "how do I use your library?".
But for companies that build systems to do something, and not libraries, there is another critical question "how does the system work? how can I change it?"
Library-based documentation is inline with the code and under the same version control system.
All too often architectural documentation is outside the code and poorly kept in sync.
This talk will look at another way of thinking about documenting systems a way that keeps architectural docs in the github repo and which plays nice with ExDoc.
Gordon Guthrie has been an Erlang programmer since 2002 and an Elixir one for quite a bit less.
Get in touch!
hi@guild.host