Design System Documentation 1720791762
Design System Documentation 1720791762
telling them
what theyThisare viseran
ifying ,
anatomy of the sections for the KYC.
Design System
Phone Number Verify phone number examples are Phone
number, email, BVN, etc
Loading state
Documentation
Shows that the email being
mail.com checked or validated The section header:
This is the head text of section, captures a
summary of the details required in the
section.
r and email The Section des
hone n umbeI rwas assigned
fr ur ther task
and con i m yo . to document the KYC component at
email add ess Describes the se
Verification Pending
what we’d collec
Shows that the email verification is
pending. could be as a result of
Phone Number Verify phone number User.clicking “Let us help” on the
verification modal
r and email
hone n umber and confirm your email address.
Verification Successful
Phone Number Verify phone number Shows that the email has
been verified.
O ptional
See Component In U se
er’s contact address. House no. and street address field can contain alphabets, numbers, spaces, and
mmas, periods, and hyphens (e.g., 123 Main St., Apt 4B). Also includes a dropdown for the country
Name
Requirement
Was it a
challenge?
The entire engineering team would work with what I have
documented, the design team would reference it for future use so...
Yes it was, but I love challenges so…why not.
Optional
Getting Started...
Rayna UI's component documentation. I took reference from there…solid stuff!
The Basics...
The first basic thing that’s needed is an understanding of the use of each
components.
Being able to describe the functions of respective parts of the components and
being able to define how they can be used and reused.
Example
The KYC Module is used to describe a module of the KYC. Think of modules like
stages…
Header text
Header text
This is an actionable Card, designed to guide users directly to the specific module they need to
complete tasks. It includes visual elements to keep users updated on their status, along with icons
Status:
doesn’t include the tooltip when there’s no need for further tips.
Icon:
clickable; The entire card is
representing the header text of the card. clickable, this is just a prompt.
Header text
document stuff...
A few
tips...
So a few tips to be able to document stuff…
don’t document beans (In this context, something that’s not relatable)
/ˈtʃɪəz/
Feel free to comment another tip that can
help with design system documentation.