My Portfolio—Documentation
Click me! I’m linked.
Glossary
Challenge
Users need to understand how certain terms relate to Skuid specifically. We were defining terms within individual topics, which meant duplicating definitions throughout the docs. (Eww. Redundancy.)
Solution
So I started building a straightforward glossary of product terms. My colleagues and I have continually added to this as needed, linking to it whenever a term is used in a documentation topic.
Click me too!
Formula / Function reference
Challenge
The Formula and Function reference had grown messy, disorganized, and confusing. As a resource for builders who were new to using formulas, it just wasn’t that helpful.
Solution
I re-organized the content into logical chunks and provided a short introduction about what these formulas could be used for.
Totally clickable.
Display Logic
Challenge
Conditional rendering, enabling, and styling are powerful tools for Skuid builders, but if you haven’t encountered them before, you need some context about how—and when—to use them.
Solution
I added a conceptual overview to our established reference materials, to help builders decide when to use display logic, and which option would best achieve their goals.
Fully linked.
Visualizations
Challenge
Why should you use a chart? Where should you use it? What type?
How do you create—and style—the visualization so that it provides the most value to your users?
Builders wanted to know.
Solution
Users love to see data visualized, but builders don’t always know how to leverage the feature effectively. So I created “Before You Chart” to get builders thinking strategically about visualizations.
Release Notes
Challenge
Depending upon the product and the company’s practices, release notes can serve a variety of purposes: alerting users to new features; telling users whether their suggestions or complaints have been addressed; identifying bugs. Skuid’s release notes detailed development activities—but didn’t really convey value to the broader user base.
Solution
While Skuid continues to have “detailed feature-and-bug” style release notes available to users when they upgrade, for major releases, we transformed the release notes on the documentation site to a narrative format. This allowed us to demonstrate ways the product was evolving, and identify new options for builders to try in the release, linking directly to the documentation. Animated gifs of features also served to call out the value of new features.
Skuid release 12.4—give it a click (you know you want to).
Skuid release 13—click it to go take a look.