We need to improve our documentation for features flags
I'm starting this discussion with the goal to come up with a protocol to document feature flags.
A good example is I just spent the last 30 minutes trying to figure it out how to have the user cards on my local. I went to success looking for a release note, found some client facing documentation, nothing technical.
Came here and found nothing...
Finally I looked directly for the code to find out some references that it might be behind a feature flag. (No readme though).
In my honest opinion, releasing a feature with no documentation is the same as the feature not existing at all.
Whenever I do some product related development I try documenting the feature I'm releasing in a readme or so. I'm not saying we should do exactly this but since we have been releasing a lot of feature flags recently I think it's becoming more pressing to have some sort of documentation protocol in place.
Comments
-
newcomment
-
anotherthinger