grafana / writers-toolkit

Technical documentation guidelines for Grafana Labs documentation
https://grafana.com/docs/writers-toolkit/
19 stars 13 forks source link

Add reference documentation for dictionary template file #710

Closed jdbaldry closed 1 month ago

jdbaldry commented 1 month ago

With reference documentation in place, I think I can start to write specific task documentation for adding different kinds of new words like:

Relates to https://github.com/grafana/writers-toolkit/issues/669

github-actions[bot] commented 1 month ago

Readability report

File AutomatedReadability ColemanLiau FleschKincaid FleschReadingEase GunningFog LIX SMOG
docs/sources/review/lint-prose/dictionary.md $${7.92\space\color{black}(Δ+0.00)}$$ $${10.75\space\color{black}(Δ+0.00)}$$ $${9.04\space\color{black}(Δ+0.00)}$$ $${52.19\space\color{black}(Δ+0.00)}$$ $${9.60\space\color{black}(Δ+0.00)}$$ $${41.75\space\color{black}(Δ+0.00)}$$ $${11.33\space\color{black}(Δ+0.00)}$$
View metric targets | Metric | Range | Ideal score | | --- | --- | --- | | [AutomatedReadability](https://en.wikipedia.org/wiki/Automated_readability_index) | 6 (very easy read) to 14 (extremely difficult read) | 8 or less | | [ColemanLiau](https://en.wikipedia.org/wiki/Coleman%E2%80%93Liau_index) | 6 (very easy read) to 17 (extremely difficult read) | 9 or less | | [FleschKincaid](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests) | 6 (very easy read) to 17 (extremely difficult read) | 8 or less | | [FleschReadingEase](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests) | 100 (very easy read) to 0 (extremely difficult read) | 70 or more | | [GunningFog](https://en.wikipedia.org/wiki/Gunning_fog_index) | 6 (very easy read) to 17 (extremely difficult read) | 10 or less | | [LIX](https://en.wikipedia.org/wiki/Lix_(readability_test)) | 20 (very easy read) to 60+ (extremely difficult read) | 35 or less | | [SMOG](https://en.wikipedia.org/wiki/SMOG) | 6 (very easy read) to 17 (extremely difficult read) | 10 or less |