How do you document the design environment?

over 4 years ago from Jason Spidle, Full Stack Designer

  • Nelson TarucNelson Taruc, over 4 years ago

    Unfortunately, no best practices I can point to/that we use. Here's how we do it.

    Documentation: The design system IS the prototype, with navigation and everything. No external tools like a design system manager. Just a link to the prototype. (Figma is awesome for making this so simple, but you have to commit to designing in Figma to make this work … you could probably make this work with Sketch if you save your prototype to the cloud).

    Changelog: Slack channel

    Versioning:Yes in both files and changelog, but it's very high level (Mk 1, 2, 3, 4) we don't do point versions.

    Naming: We haven't figured this out yet either. Generally we defer to what our developers prefer (which is often camel case).

    FWIW, I've researched other DLS implementations and it's really company-specific. What works at one org would be a disaster at another. I think that's why it's hard to find a common set of best practices.

    4 points
    • Jason Spidle, over 4 years ago

      Thanks for sharing. Definitely understand that without a killer tool that nails this problem, it'll vary a lot from team to team. Do you match developer preferences on files to expedite dev?

      0 points