Maps of the Codebase
Inspired by Peter Turchi's "Maps of the Imagination: The Writer as Cartographer," we explore the convergence of cartography and technical writing in software documentation. We'll delve into how maps, as narratives that guide and inform, parallel the goals of effective documentation—telling the story of a codebase and providing clear navigation, We'll uncover insights on crafting documentation that serves as a compass for developers, marrying the art of storytelling with the precision of technical detail to create a more navigable and understandable software landscape.
AmsterdamJS
AmsterdamJS is the largest and longest-running JavaScript meetup in town!
JavaScript has a bright shining future and the Amsterdam tech scene is thriving. Although there are vibrant user meetups and conferences on related topics, the city needs a strong and all-embracing JavaScript community and AmsterdamJS is it, since 2010.
Our goal is to cover everything JavaScript, from the browser to the server, from the framework to the crazy hack and from the hardware appliance to the data visualization. We also run an annual conference - JSNation
Contact email: events@gitnation.org
Submit your talk proposals here https://shorturl.at/rtH45
Propose the venue for next meetups https://shorturl.at/nuxQ1
By joining this group you agree to comply to our Code of Conduct https://jsnation.com/coc
Literate Computing in Elixir (and more)
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.
Gordon Guthrie
Platform Sponsors
Don't let broken lines of code, busted API calls, and crashes ruin your app. Join the 4M developers and 90K organizations who consider Sentry “not bad” when it comes to application monitoring. Use code “guild” for 3 free months of the team plan.
https://sentry.io
Torc is a community-first platform bringing together remote-first software engineer and developer opportunities from across the globe. Join a network that’s all about connection, collaboration, and finding your next big move — together.
Join our community today!
Maps of the Codebase
Inspired by Peter Turchi's "Maps of the Imagination: The Writer as Cartographer," we explore the convergence of cartography and technical writing in software documentation. We'll delve into how maps, as narratives that guide and inform, parallel the goals of effective documentation—telling the story of a codebase and providing clear navigation, We'll uncover insights on crafting documentation that serves as a compass for developers, marrying the art of storytelling with the precision of technical detail to create a more navigable and understandable software landscape.
AmsterdamJS
AmsterdamJS is the largest and longest-running JavaScript meetup in town!
JavaScript has a bright shining future and the Amsterdam tech scene is thriving. Although there are vibrant user meetups and conferences on related topics, the city needs a strong and all-embracing JavaScript community and AmsterdamJS is it, since 2010.
Our goal is to cover everything JavaScript, from the browser to the server, from the framework to the crazy hack and from the hardware appliance to the data visualization. We also run an annual conference - JSNation
Contact email: events@gitnation.org
Submit your talk proposals here https://shorturl.at/rtH45
Propose the venue for next meetups https://shorturl.at/nuxQ1
By joining this group you agree to comply to our Code of Conduct https://jsnation.com/coc
Literate Computing in Elixir (and more)
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.
Gordon GuthriePlatform Sponsors
Don't let broken lines of code, busted API calls, and crashes ruin your app. Join the 4M developers and 90K organizations who consider Sentry “not bad” when it comes to application monitoring. Use code “guild” for 3 free months of the team plan.
https://sentry.io
Torc is a community-first platform bringing together remote-first software engineer and developer opportunities from across the globe. Join a network that’s all about connection, collaboration, and finding your next big move — together.
Join our community today!
Get in touch!
hi@guild.host