openSUSE / suse-doc-style-checker

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

suggested updates for Style Checker #177

Open cjschroder opened 2 years ago

cjschroder commented 2 years ago
  1. Harmonize with the Style Guide
  2. Improve or remove:
    • too-long sentences
    • callouts limited to 10
    • procedures limited to 10
    • computer elements
    • too-long URLs check
  3. improve: wordy phrases check
  4. terminology: remove "due to" "need to" "please" check, align with terminology database

Note that the style checker is used most often before a new SLE release, so we have some months to work on this. Hopefully we can make it useful enough for writers to use it routinely.