2018-05-06 02-00-13
João Melo
mvp_badge
MVP
Architecture Dashboard - Turn the "Missing description on public element" into an optional Indicator
563
Views
3
Comments
Working on it
Architecture & Governance 

Some teams have been keeping technical documentation on a separate document format instead of generating using OutDoc to leverage, which makes this Indicator, especially in cases where the Application is not meant to be a component or widget, unnecessary.

So, maybe if there was a Settings feature where we could set this Indicator as optional / mandatory for a given Application, it would be helpful.

+1 to the idea.

Some inputs and actions are also self-explanatory and not necessarily a mistake. The amount of warnings generated by this indicator and the fact that they need to be snoozed (so that we can focus in warnings that are more relevant) is a huge effort for the teams.

Changed the category to
Architecture Dashboard
and the status to
On our RadarOn our radar

Hello all, 

We are looking into this topic. 

The solution might not be to make it optional, but somehow reduce the false positives.

Changed the status to
Working on it
expected delivery in Q3 2021

We are reviewing the missing description patterns, and after discussion with the mvp community we were able to determine new guidelines. They will be implemented and released to more value-focused findings.

New rules will be:

Mandatory

  • site properties
  • modules
  • actions
  • entities
  • structures
  • parameters

Not mandatory (anymore)

  • attributes of entities
  • attributes of structures


Kind regards,

Pedro

Commented on another thread - this finding should be a warning in service studio so developers deal with it immediately...