Linter

The Linter automates content validation by checking documentation against your company’s style guide and established writing standards. It streamlines the manual review process writers typically perform with external tools.

You can configure custom rules to enforce code formatting, word choice, and adherence to internal style and best practices. Whether your documentation includes custom HTML or extensive code samples, the Linter ensures consistency across all your docs.

---

Configure

You can add prompts to the Linter that are categorized as style guide, errors, or warnings.

Style Guide: Write about what makes for great docs and the Linter will score your content. Example:

Keep it short:

Short text is always better. Short paragraphs are easier to read. Try to keep headings to one line. Two-line headings take up twice as much vertical space. Use short words in headings; if a customer uses larger fonts to improve accessibility, long words may break across lines.

Clarity:

Clear and concise text for easy scanning and readability. Get to the point so users can easily find what they need. Don’t use excessive words.

Natural and human tone:

Use everyday words that’s easy to understand. Less format but more professional than everyday conversation. Occasionally use a fun tone for celebratory moments but never for informational text. Be warm and supportive to users reading the docs.

Errors: Rules that can be checked objectively. Example:

Capitalize ReadMe properly:

Bad: Readme

Good: ReadMe

Wrap code elements in backticks (`):

Bad: Run npm install –g my–package

Good: Run npm install –g my–package

Flag placeholder text like TODO, FIXME, or Lorem ipsum

Example: TODO: Add description and image to this feature

Warnings: To point out issues that may be subjective. Example:

Hedging Language:

Avoid using uncertain or overly cautious language. It undermines confidence and make your instructions less direct. Opt for clear, confident language.

Bad: You might want to consider installing the latest version.

Good: You can install the latest version to access new features.

Weak writing:

Avoid weak writing like ‘You can’ or ‘There is’. These phrases bury the action, make writing less direct, and often add unnecessary words. Strong docs are clear and action-oriented.

Bad: You can configure the API by editing the settings file.

Good: Configure the API by editing the settings file.

Active voice:

Refrain from using passive voice. Active voice is clearer, shorter, and tells the reader exactly who is doing what.

Bad: The token is generated when the user logs in.

Good: The system generates a token when the user logs in.

Running the Linter

Once configured, running the Linter checks your page against your prompts. Issues can be fixed automatically using the Agent.

FAQ

Where should I send feedback or questions?

Email feedback or questions to [email protected]

What model does the Linter use?

At the moment we use Gemini 2.5 Flash—though that may change as we adjust to balance quality and speed. In the future users will have the option to select models of their choice.