Forum

Ability to document different use cases for a "component"  

  RSS

Bitovi
Member Admin
Joined:1 year  ago
Posts: 8
August 24, 2017 3:00 pm  

How can different use cases for a "component" be documented in the style guide. Does that mean that the style guide would need to be connected to the same database the app uses?

Edited: 1 year  ago

ReplyQuote
Adriana De La Cuadra
Member Admin
Joined:1 year  ago
Posts: 8
August 28, 2017 8:15 pm  

The idea of using a living style guide is that the documentation is connected to the source code, which includes showing components that would usually use mock data via fixtures. Typically fixed data is used for testing purposes, but it can also be used for demonstrating how a component works, and therefore show back to back the different use cases the component supports.

 


ReplyQuote
  
Working

Please Login or Register