design-documentation

2 posts

figma

Documentation That Drives Adoption | Design Systems 103 | Figma Blog (opens in new tab)

Clear documentation turns a design system from an abstract set of rules into a practical tool teams can use consistently. The article argues that effective documentation must explain both how to implement components and why design decisions were made. When treated as a living resource, it improves adoption, onboarding, cross-functional communication, and product consistency. ## Documentation Bridges Design and Development - Razorpay’s teams often missed details such as button states and text-field error behavior before adopting its Blade design system. - Custom, hard-coded implementations made it easy for teams to omit important states or interactions. - Designers and developers may use different terminology, leading to: - Inconsistent naming conventions - Misaligned component properties - Different expectations about product behavior and appearance - Documentation connects design intent with technical implementation. - It should capture the reasoning behind decisions, not merely catalog available components. ## Benefits of Effective Documentation - Helps teams understand design principles and implementation details. - Encourages consistent decisions across products and platforms. - Speeds up onboarding for new team members. - Creates a shared language between designers and developers. - Reduces the risk that a carefully built design system will go unused. ## Choosing a Source of Truth - The first documentation decision is determining where information should live, rather than deciding what to write first. - Maintaining consistency becomes more difficult as design systems and organizations grow. - Static PDFs stored in shared drives quickly become outdated and disconnected from daily workflows. - Modern teams can choose among dedicated documentation sites and collaborative workspaces. - The best source of truth should fit the organization’s tools, processes, and scale. ## Custom Documentation Sites - Custom sites are particularly useful for large organizations. - They can integrate deeply with existing design and development tools and organizational processes. - A dedicated site provides a centralized, discoverable location for design principles, components, usage guidance, and implementation details. Effective design-system documentation should be centralized, searchable, and continuously maintained so that it remains aligned with both the system and the teams using it.

figma

State of Design Systems 2018 | Figma Blog (opens in new tab)

Figma’s 2018 survey of 499 practitioners shows that design systems were still developing, but were becoming a lasting part of digital product work. Most organizations lacked mature systems or dedicated teams, yet practitioners strongly aspired to more formal, public, and continuously maintained systems. The report also argues that design systems are processes and principles—not merely collections of reusable components. ## Design Systems Were Still in Their Infancy - Two-thirds of respondents described their systems as stage 1 or 2: - Undocumented - Lacking a dedicated maintenance team - 86% wanted to reach stages 3 or 4, involving full-time staff and publicly available systems such as Shopify Polaris. - Speakers at Clarity suggested that design systems would become standard practice, much like responsive design. ## A Dedicated Team Is Not Required - About half of respondents worked at companies with design-system teams, mostly organizations with more than 1,000 employees. - Only one-third believed a dedicated team was necessary. - Smaller teams and individuals can begin incrementally by solving one focused problem, such as establishing consistent line-height rules. - The recommendation was to start small and ship improvements rather than wait for a complete system. ## Systems Usually Follow Existing Products - Only 41% of respondents built a design system alongside a new product. - 52% created one from an existing product, while 7% had experience with both approaches. - Building from a real product can be advantageous because the system addresses actual use cases instead of creating isolated, hypothetical components. - Legacy design can therefore provide a practical foundation for system development. ## Common Design-System Artifacts - Component libraries appeared in 90% of respondents’ systems. - Style guides were included by 83%. - Other commonly mentioned elements included: - Design principles: 57% - Content guidelines: 47% - Code-related resources such as React components, mixin libraries, and design tokens - Only two respondents mentioned linters, highlighting the wide variation in what organizations consider part of a design system. ## A Design System Is More Than Its Artifacts - The most common misconception was treating a design system as a static collection of pattern libraries. - A complete system also includes: - Processes - Guidelines - Principles - Design philosophies - Documentation - Component libraries are outputs of the system, not the system itself. - Without documentation explaining the reasoning behind components and how to use them, even a technically strong system can fail. A practical approach is to begin with a small, real product problem, document the principles behind the solution, and grow the system iteratively rather than waiting for a dedicated team or a fully formed library.