Guiding Digital Implementation: Designing a Resource for Content Editors and Developers
User Experience | Content Design | Texas Department of Transportation
Project Overview
Our team created TxDOT’s first-ever digital design system documentation, providing structured guidance for developers and CMS authors. Before this initiative, there were no formal resources—just scattered anecdotal feedback highlighting the need for documentation. Our goal was to create design consistency and improve the CMS authoring experience by offering a single source of truth.
My Role
As the UX Manager, I:
Defined the initial blueprint for the documentation structure.
Led discussions between the UX Designer and CMS Admin to ensure alignment.
Reviewed and approved documentation to maintain clarity and effectiveness.
Coordinated with broader stakeholders, including a QA Specialist, Information Architect, and Web Manager, to gather feedback and refine the resource.
The Challenge
Since no prior documentation existed, we had to build from the ground up. The biggest hurdles included:
Structuring the content—Organizing information in a way that served two distinct audiences: developers and CMS authors.
Deciding what to include/exclude—Balancing detail without overwhelming users.
Limited resources and time—We needed to launch quickly without extensive user testing.
Solution & Execution
We developed a component-based structure, ensuring clarity and ease of use. Each component page includes:
Anatomy – Visual breakdown of the component structure.
Short authoring video – Step-by-step guidance for CMS users.
Sample component – Interactive example demonstrating the component in use.
Best Practices – Guidelines for optimal implementation.
Accessibility Considerations – Ensuring compliance with WCAG standards.
Authoring Checklist – Quick-reference guide for CMS authors.
While we plan to include code snippets in the future, we decided to defer them due to the varied codebases across our teams and the limited bandwidth of our small UX team.
Sample Components
Sample Documentation
Key Decisions & Trade-offs
Prioritizing CMS Authors First: Since CMS authors manage daily updates and directly benefit from documentation, we tailored content heavily toward their needs first.
Delaying Code Snippets: Managing multiple codebases made universal code snippets impractical at launch. Launch First, Iterate
Later: Given our time constraints, we focused on delivering a foundational resource first, with plans to expand and refine over time.
Results & Impact
CMS Authors Love It – We received positive feedback from website authors, who appreciate having clear guidance.
Developer Feedback Pending – Since most developers are external contractors, we haven’t yet gathered extensive feedback from them.
Future Plans – Next steps include completing documentation for all components, introducing page templates, and creating higher-level best practices to further enhance usability.
Lessons Learned
Even basic documentation is a game-changer – Having a single source of truth dramatically reduces confusion and inconsistencies.
Balancing detail is key – We refined our approach to serve both CMS authors and developers without overloading either audience.
Iterate and expand – Instead of waiting for perfection, we launched an MVP version and will continue improving based on user needs.
Final Thoughts
This project laid the foundation for a structured, scalable digital design system at TxDOT. With continued iteration and expansion, we aim to create an even more robust resource that streamlines development, enhances CMS authoring, and ensures long-term design consistency across all digital products.