Document best practices for components README

Add guidelines to the components "Best practices" section
on how to write good documentation for components.

Issue: https://gitlab.com/gitlab-org/gitlab/-/issues/430816

Changelog: other