Part 3: The Implementation
One of my passions is documentation, a task that poses challenges for many companies and projects. At RigUp, I was challenged to find a way to aid our developers in improving documentation practices and quality. You can read about the first part of my journey in Part 1, and the system we chose to implement in Part 2.
Once I had a plan for a system to implement, the actual work of making it happen began. I built a small working group of invested technical leaders from the company and presented my ideas.
Of course, that’s…
Part 2: The System
One of my passions is documentation, a task that poses challenges for many companies and projects. At RigUp, I was challenged to find a way to aid our developers in improving documentation practices and quality. You can read about the first part of my journey in Part 1: The Journey.
Once I realized I needed to develop a system that enabled developers to write documentation as quickly and painlessly as possible, I was able to completely reframe the problem. …
Part 1: The Journey
I love to write documentation.
I’d like to claim that I’m motivated by noble reasons like sharing knowledge and growing talent, but honestly I just hate to explain things more than once. Writing quality documentation ensures the availability of information that might otherwise exist only in my head. It reduces the frequency with which I have to repeat myself. It means fewer interruptions while I’m on vacation. It enables us, as a team, to scale more efficiently by reducing the time needed in-person to introduce new developers to our codebase.
Unfortunately, we haven’t always been great…
When I started at RigUp four years ago, our journey toward a design language system had already begun. Like so many others, it started out with rebranded Bootstrap components.
As you may know first-hand, we encountered a number of issues with this: overrides to rebrand components led to long cascades and many important! declarations littering our SASS files. Bootstrap documentation was considered sufficient for our needs, so nobody ever documented the custom classes or custom functionality we’d added. All of this made it very difficult to find what you needed and led to multiple functional duplicates.
Around the time “pattern…
Senior Web Developer @ Shopify & self-styled nerd. She/her.