Skip to main content

Support FAQs Content

The Authoring Guide is a site that contains information on the State of Oklahoma’s web page components, theme-able templates, and other useful information for state agencies such as accessibility guidelines.

The authoring guide contains a list of available components, which serve as the the building blocks for any agency website. They have all been designed to adhere to Adobe Experience Manager (AEM) best practices. These components have been developed in AEM, which allows authors to easily drag and drop components to any permission-based page in order to quickly arrange, configure, and publish to the respective environments before pushing live.

In addition to displaying available components, the authoring guide provides teams across any agency and cross-functional discipline with the right information and knowledge to update or create new SOK-specific digital experiences. Our intent is to provide visibility to any team accessing this guide to stay up to date on the latest developments, and as a means to quickly ramp up on AEM with all the available tools at your disposal. In addition, this central repository will enable us to standardize our authoring approach across the broader ecosystem to encourage component re-use and to provide a more consistent and branded experience for all constituents that visit each agency site on a regular basis.

The component library describes each component in detail with relevant screenshots, and support information where needed. All components are fully responsive and meant to work seamlessly across any device.

The authoring guide’s primary audience is any group working to create, update, or launch any State of Oklahoma agency website. It can be used as a reference source to learn more about each template and component type prior to authoring within AEM. Teams that will find the guide useful include:

  • Admins, AEM and content authors
  • Vendors and 3rd party creative or development firms
  • Digital team managers and State Agencies product owners
  • AEM developers, front end developers, and Quality Assurance teams
  • Content and assets production groups
  • Content editors and copy writers
  • Analysts, Personalization and Optimization teams

One of the key goals behind the authoring guide is to foster re-usability of existing components by streamlining user adoption through our standardized digital Design System. When it comes to planning and designing future SOK sites, we encourage User Experience Design teams to adhere (wireframes, visual mockups, and prototypes) to the library of components which were created to cover the majority of use cases and UI needs based on business goals. We advise that deviating from the core components found in this component authoring guide will incur additional development costs and may delay launch timeframes.

In terms of governance, the authoring guide provides a structured and well-organized standardized system providing transparency to any cross-disciplinary team across all agencies. From a constituent perspective, a consistent library improves ease of use and memorability as users come back to each site time and time again. From a Brand approach lens, it also ensures that the SOK identity and branding guidelines are reinforced across any digital experience for any represented industry; whether it is tech, agriculture or finance (to name a few), the design components will still look, behave, and function as intended.

The Authoring Guide contains a detailed list of components. We have grouped the components across a few functional categories to make it easier for page authors to find:

  • Actions: Contains Call-to-Actions (CTAs), buttons, anchor links, link list, social share icons, and more.
  • Containers: Components including multiple design elements such as FAQs, modals, carousel, alerts, etc.
  • Data Visualization: Includes tables, event calendar view, county map, API-driven embedded elements.
  • Headers & Footers: Global and State Agency top and bottom page-level navigation and informative sections.
  • Media: Components for adding images, videos and audio files to a page.
  • Typography: Individual components for arranging text headings on a page such as titles and body text.

Currently there are around 50 components available within the library.

Last Modified on Nov 12, 2020
Back to Top