IDEA: docs quality maybe could be captured with language stats (reading level,...
IDEA: docs quality maybe could be captured with language stats (reading level, word count, sentence length)
Current tools capture little stuff (template lint), existence, spelling, grammar. But not "is this developed enough to not be $#!+"
It's that time of year I think I should write a docs oriented build script. Then I look at the machine generated output and it looks like a Visual Studio Object browser.
Self-replies
Maybe we shouldn't generate object hierarchy docs until we got a README with standard sections, a CONTRIBUTING with standard sections, etc. For the User manual and Reference manual, not so sure one size fits all, but the same approach could be used, for say, the 15th microservice in your portfolio.