search

grafana / writers-toolkit

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

Document how to add words to the Vale dictionary #719

Closed jdbaldry closed 3 months ago

jdbaldry commented 4 months ago

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

github-actions[bot] commented 4 months ago

Readability report

File AutomatedReadability ColemanLiau FleschKincaid FleschReadingEase GunningFog LIX SMOG
docs/sources/review/lint-prose/_index.md $${5.54\space\color{black}(Δ+0.00)}$$ $${8.75\space\color{black}(Δ+0.00)}$$ $${6.99\space\color{black}(Δ+0.00)}$$ $${62.31\space\color{black}(Δ+0.00)}$$ $${9.50\space\color{black}(Δ+0.00)}$$ $${30.83\space\color{black}(Δ+0.00)}$$ $${10.19\space\color{black}(Δ+0.00)}$$
docs/sources/review/lint-prose/dictionary/_index.md $${6.94\space\color{black}(Δ+0.00)}$$ $${10.18\space\color{black}(Δ+0.00)}$$ $${8.93\space\color{black}(Δ+0.00)}$$ $${50.04\space\color{black}(Δ+0.00)}$$ $${10.36\space\color{black}(Δ+0.00)}$$ $${40.51\space\color{black}(Δ+0.00)}$$ $${11.21\space\color{black}(Δ+0.00)}$$
docs/sources/review/lint-prose/dictionary/add-words.md $${5.63\space\color{black}(Δ+0.00)}$$ $${9.23\space\color{black}(Δ+0.00)}$$ $${6.52\space\color{black}(Δ+0.00)}$$ $${63.14\space\color{black}(Δ+0.00)}$$ $${7.93\space\color{black}(Δ+0.00)}$$ $${35.10\space\color{black}(Δ+0.00)}$$ $${9.73\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 |
jdbaldry commented 3 months ago

New content looks good.

Question: Should we suggest/recommend putting a description field with all words?

I've added a step to each task to encourage the addition of a description in 08d8f0147656a10a3628ad1167b407cd5b15b2e8