Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[EPIC](design): Initial Design Document Implementation and Example App Rework #541

Open
8 tasks
edda opened this issue Oct 21, 2024 · 0 comments
Open
8 tasks
Assignees

Comments

@edda
Copy link
Contributor

edda commented Oct 21, 2024

Description

This epic focuses on the creation and application of an initial version of a design document that will serve as a reference guide for app developers using our design system. The design document will contain guidelines and UX patterns aimed at standardizing frontend app development.

The first validation of the document will involve reworking the existing example app to align with the new guidelines. Feedback on the design document’s clarity and ease of use will be gathered during this process, and the outcome will be both an improved example app and valuable insights for refining the design documentation.

Objectives:

Create an Initial Design Document:

Develop a comprehensive design document that includes guidelines, UX patterns, and best practices for app developers using the design system. This document will serve as a reference for standardizing the look and feel of frontend applications.

Rework the Example App:

Rework the existing example app, ensuring it follows the guidelines outlined in the design document. This will serve as a real-world test of how easily developers can adopt and implement the design system.

Gather and Incorporate Feedback:

Collect feedback from developers regarding the ease of use and clarity of the design documentation during the rework of the example app. This feedback will help identify areas of improvement for the documentation.

Tasks:

  • Develop the initial version of the design document, including all necessary guidelines and UX patterns.
  • Rework the example app according to the new design guidelines, ensuring full adherence to the design system. Also migrate it to TypeScript in the process
  • Collect feedback from developers involved in the rework, focusing on the usability of the design document.
  • Refine and update the design document based on the feedback received.

Acceptance Criteria:

  • The initial design document is complete, containing clear guidelines and UX patterns.
  • The example app has been fully reworked according to the guidelines in the design document.
  • Feedback from developers is collected, focusing on the usability and clarity of the design document.
  • A refined version of the design document is created based on developer feedback, improving clarity and ease of use.

Dependencies

Identify any other epics, issues, or tasks that this epic depends on.

  • Dependency 1
  • Dependency 2
  • Dependency 3

Additional Notes

Any additional information, context, or considerations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants