Sentence Length Check

This rule checks for overly long sentences by counting the number of words in each sentence and flagging any that exceed 30 words. The rule helps maintain readability and clarity in your writing by encouraging shorter, more focused sentences.

Long sentences can be difficult for readers to follow and understand, often containing multiple ideas or complex clauses that could be better expressed as separate thoughts. Breaking down long sentences into shorter ones helps readers process information more easily and maintains their engagement with the text.

Examples:

Passes:

  • "The new feature allows users to quickly process their documents."
  • "We implemented the changes based on customer feedback and initial testing results."

Flags:

  • "The new system implementation includes multiple interconnected components that work together to process user input while simultaneously monitoring system performance and generating detailed reports for administrative review." (27 words - too long)
  • "After careful consideration of all the feedback received from our beta testers, including detailed analysis of performance metrics and user experience surveys, we decided to implement the suggested changes to the interface design and underlying architecture." (35 words - too long)

Rule Source

This rule comes from: https://github.com/mesosphere/dcos-docs-site

Rule Definition

extends: occurrence
message: "Try to keep sentences short (< 30 words)."
scope: sentence
level: suggestion
max: 30
token: \b(\w+)\b