department-of-veterans-affairs / va-forms-system-core

VA Forms System Core will be a React library hosted in NPM that will allow engineers and designers to easily interact with Forms inside of vets-website.
https://department-of-veterans-affairs.github.io/va-forms-system-core/
6 stars 4 forks source link

(Placeholder) Forms Library Documentation Recommendations #569

Open taylorkaren opened 2 years ago

taylorkaren commented 2 years ago

This is a list of potential improvements to the current Forms Library documentation site, from this Research Findings page:

  1. Consider adding labels (tags) to the Forms Library documentation pages or assessing ways to improve search results accuracy.
  2. Consolidate related content, such as listing all potential parameters and both the uischema and schema for fields and widgets in one spot.
  3. Audit the current IA and content to determine where content can be combined or added for clarity.
  4. Add more examples of complex form implementations in production, with guidance on best practices, particularly for custom components.
  5. Simplify naming conventions on the current Forms Library Documentation to reduce title verbosity.

Move these to their own separate ticket if and when work is done for any of these.