Back to Materialize

README

console/doc/design/README.md

123982 B
Original Source

Console Design Documents

See the README in the MaterializeInc/materialize repo for Materialize's guidance on:

  • What's the purpose of a design document?
  • Goals of a design doc.
  • Non-goals of a design doc.
  • When should you make a design document?
  • How should you make a design document?
  • The creation, iteration, and approval process.

You can also check out recent design doc examples in that subdirectory.

Additional Console-Specific Guidance

  • Create your console design documents within the console/doc/design/ directory.
  • Follow the console-specific template 00000000_template.md.
  • For all user-facing features, share your design doc with the appropriate designer and PM as well. You should also collaborate with the designer and PM as you write the design doc where applicable, to define the problem and iterate on the MVP and mockups.