openSUSE / suse-doc-style-checker

Style Checker for SUSE Documentation
Other
2 stars 5 forks source link

Consider some rules from OpenStack writing guidelines #152

Closed tomschr closed 7 years ago

tomschr commented 7 years ago

Just for the record (nothing important nor fancy).

For example, the OpenStack community has some General writing guidelines.

Some rules could be interesting for our style checker too: Write positively, Avoid prepositions at the end of sentences, Do no overuse this, that, these, and it and probably more.

Probably not all are useful or can even be transformed into a specific regex.

ghost commented 7 years ago

I guess this should better be at https://github.com/SUSE/doc-styleguide . -> Closing here, reopened as https://github.com/SUSE/doc-styleguide/issues/61.

tomschr commented 7 years ago

Thanks, for opening it on the SUSE domain too. I first thought about adding some rules in the style checker. But probably that way is even better: first digest the other guide and then try to extract and create some meaningful rules for it. 😸