[Feature request] Use surveyor to assess whether an API doc is complete or not about surveyor HOT 2 OPEN

This sounds like a great use of the tool (either cribbing from analyze-sample-code or rolling something similar of our own). @jayoung-lee: do you know if there's interest in motivating a broader survey of API docs in response to the satisfaction study?

from surveyor.

I should have been more clear about the context of this request!

We have a satisfaction survey (HaTS) that's been running on the Flutter's top 20 API docs and collecting satisfaction scores since stable 1.5 release. Because the survey will continue to collect the satisfaction scores, I plan to use the surveyor to help with the analysis. More specifically, I plan to run the surveyor after each release of stable to see if any doc's been updated. Then, I will join the surveyor results with the HaTS survey results, which will help me more easily track how the changes in the API docs (e.g., added image) influence the satisfaction (instead of going through 20 pages manually after each release).

What I can also do is creating a dashboard that shows the ranking of API docs by the number of visitors (from Google Analytics) along with the information on whether a doc is missing snippets or images (surveyor output), so that the team members can easily identify which doc needs love.

Another use case that @InMatrix suggested is to use the same surveyor for the documentation of Flutter/Dart packages. From the Q2 survey we found out that one of the biggest pain points in using packages was the lack of documentation, especially the code samples (article). I think we can propose to use the surveyor outputs as one of the quality metrics.

from surveyor.