openSUSE / suse-doc-style-checker

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

Correct sentence order of instructions #98

Open ghost opened 8 years ago

ghost commented 8 years ago

If "to + infinitive", "for + gerund", or "if"/"when" are appearing in the middle of the sentence, the order of the sentence is probably wrong: you should first describe the goal of an action, then what to do.

This could be limited to text within step/para to avoid some false positives. However, given the amount of paras we still have that should actually be procedures, we might miss half or more of the occurrences we have.

We might also try to see if a para sounds too much like a procedure by checking for the number of "to"s and "then"s and propose making it a procedure...

Con of implementing this: angering some colleagues. :/