Designing the «Documentation» page
During the analysis of documentation requirements and research of best practices, it was found that effective documentation for the HeyAuto design system should not only serve as a source of information about design foundations and components but also support all participants in the product development process—from new employees (designers, developers, customer service, marketing) to existing ones. Based on this analysis, a documentation structure was developed.
"Documentation" addressed the following aspects:
1. The Need of Design System: This section describes the value and importance of a design system for unifying and optimizing development processes at HeyAuto. It emphasizes how the system contributes to product consistency and simplifies the onboarding of new team members.
2. Foundations of Google's Material Design 3 in Our System: This section details the implementation of Google's Material Design 3 principles within the HeyAuto design system. It describes how foundation solutions are adapted to meet the specific requirements and goals of the project.
3. File Organization: This section provides guidelines for structuring and managing design files, covering file naming conventions, branching, and resource sharing.
4. Communication and Handoff to Developers: This section outlines the processes and best practices for effectively transferring projects from "in progress" to "devs ready", including the use of figma dev tool.
5. Responsive Design: Guidelines for creating adaptive designs that ensure optimal display and functionality across various devices and platforms.
6. Idea to Implementation: An overview of the product development lifecycle at HeyAuto, from initial concept, stage testing, to deployment, with a focus on the role of the design system at each stage.
7. Handoff Structure: An overview of the teams involved at every stage, detailing their roles, responsibilities, and interactions within the design system framework.
Conclusion: This approach to developing the "Documentation" section of the HeyAuto design system ensures design consistency and coherence throughout the product development process. It also acts as a valuable resource for training and onboarding new team members and fosters improved communication and collaboration between various departments.