How to describe elements/widgets properly?
We are making widgets for a corporate website and I'm trying to figure out the best way to describe them. Something like writing a documentation.
There are at least 10 of these, but here is one component structured for example:
COMPONENT NAME: Container
DESCRIPTION:
- Containers component is designed to show mixed content like text, image or button.
- Container can be split in one, two, three, four columns
Container can have other components inside itself:
- for example: if you make a container with background image, content inside will still be distributed by columns and rows (like table)
VARIABLE ELEMENTS: Number of columns, content of each column. Text, image, button and other component (other component can be for example slideshow)
EXAMPLE: [we provide screenshot here]
LINK: [we provide link to a prototype]
Is this enough descriptive? What can I do to help developers understand better?