Design Documentation

Why

We need documentation on how to work with the catalogue to understand decisions, possibilities and best-practices, that goes beyond development.
The focus target of this documentation would be Designers, Product/Project Managers and prospects (as well as a good piece of marketing of our UI platform). 

Nevertheless, this should also be relevant information for any other users of the Element’s catalog, like Product Engineers, Professional Services, Solution Engineers or any other external developer. It should especially inform on the best design practices when lack of specifications.

How

Should be implemented on Nuxeo Docs, but highly influenced by what other platforms on this scope do, like: https://zeroheight.com/ or https://www.invisionapp.com/design-system-manager.

Documentation should include:

• Best practices
• Guidelines
• Basic styling (colors, types, etc..)
• Relevant elements with purpose, decision, usage and identifying their different states.
• Include whenever is relevant embed examples from Nuxeo’s Storybook, included in the Technical documentation.

A good starting point is to analyse Nuxeo’s previous StyleGuide.