I joined the Serverless family about a month ago (in startup months, so make that 14 in enterprise company months). Let’s just say the ramp-up curve has been...intense. I’ve built complex developer tools before, but never for open source, and never with this many moving parts.
But hey, when you gain knowledge fast, might as well share it around, right? Here are 3 things to keep in mind when it comes to designing dev tools in this new (to me, anyway) context.
1. Engineers need two screens for a reason
Code wrangling comes with a full posse of devious collaborators. You’ve got:
- multiple terminal windows for writing code and accessing file structures
- additional browser windows for viewing live changes
- GitHub and Waffle (or if you prefer, waffle) for project tracking and asynchronous comms
- plus a couple extra windows for those reams of documentation (try using AWS without docs, certainly not pretty)
Once you add in Google Drive, Slack and break-time Twitter, a savvy developer needs at least 2 screens, if not 3.
So what does that mean for slick dev tool design?
Enable rapid context switching between services. Let people deploy some code (switch), check that it loaded correctly in the browser (switch), open up a metrics dashboard to see why it’s not grabbing http requests (switch), rant about it on Twitter (switch), coffee break.
Spending hours in the depths of Atom cranking out code is the exception these days, not the norm, and designers of developer tools mustn’t forget it.
2. Balance the CLI and UI
There’s an art to ensuring that information presented in the UI is complementary to what the user is accomplishing in the CLI. If you don’t get the balance right, your tool can end up being a workflow impediment rather than a benefit.
Let’s walk through an example I dealt with recently: someone signing in to Serverless.
If the user has logged in before, it’s probably best for them to type
sls login into the CLI and bam—they’re in. But what if the user is logging in for the first time? You could definitely handle this flow with in-line CLI prompts, but this ends up being clunky and can take ages. By funneling the user through a UI, you’ll have way more control over making it a great experience and getting them to the “Ah HA!” moment as quickly as possible.
Another thing to never forget as a dev-tools designer: in the CLI, an engineer will use shortcuts for everything. No need to take the scenic route to what they’re looking for; using shortcuts is like snapping your fingers outside a hotel lobby and being teleported straight to the comfy sofa in Room 202 where you’re watching Fixer Upper on HGTV. Magical.
From a design perspective, this means that as long as the core commands still work, the entire structure of the application can change and engineers might not even notice or care. All they need to know is that a finger snap puts them on their comfy sofa.
Of course, a UI takes a wholly different approach, providing progressive context and waypoints to craft a user journey.
Continuing with the hotel example: users start in the lobby, walk past the concierge, see the signs for the elevators, smell fresh-baked cookies wafting from the continental breakfast... All these cues help users orient themselves. Remove or move too many of them and the overall experience can be ruined.
Tl;dr: be careful about changing the UI. The CLI doesn’t matter as much.
3. Open source vs. focus
One of the things that drew me into Serverless from day one was the passionate developer community. We wouldn’t be where we are today without all those issues and PRs.
Having said that, being open source adds an interesting aspect to the product development process: where a typical engineering planning meeting might involve going through maybe a couple handfuls of active issues and open PRs - we have dozens. And being responsible product owners, we make sure to review and reply to all of them, all of which takes time.
The (positive) flip side is that many suggestions end up actually informing the direction of our product. Honestly—we frequently discuss user-submitted issues that uncover things we either hadn’t planned for or hadn’t realized were so important. It makes for some pretty lively development to say the least :)
Design @ Serverless
As a semi-technical non-developer, I’ve embraced the daily ins and outs of how our own team works. CLI? For breakfast, lunch and dinner now, thanks.
I’m keeping all this in mind as the team works hard to bring you the next generation of serverless tools, and in the meantime I’d love to hear from other people solving similar design challenges. Stay tuned!