Skip to content

[Claude PR] Add claude_feedbacks.md for writing style feedback #1008

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Jul 7, 2025
1 change: 1 addition & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ These guidelines ensure consistency and quality when writing or modifying Windmi
## Content

- The doc should focus on the user experience, not on the engineering behind it, unless it's important (e.g. feature related to performance)
- **Before writing new documentation, review @writing_style_guide.md for guidance about how to write good documentation**

## File structure and naming

Expand Down
22 changes: 22 additions & 0 deletions writing_style_guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Claude writing style guide

This file contains writing style guidance when creating Windmill documentation. Review this guide before writing new documentation.

## General writing style issues

### Overly marketing language

**Problem example:**
"Windmill can automatically fill your script and flow input forms using AI to save you time and effort. This intelligent feature analyzes your form parameters and can populate them with contextually appropriate values based on your requirements."

**Issues:**

- Too long and verbose for technical documentation
- Marketing language like "This intelligent feature" sounds promotional rather than technical
- Users prefer concise, direct explanations over flowery descriptions

**Better approach:**

- Keep descriptions short and technical
- Focus on what the feature does, not how "intelligent" or "smart" it is
- Use straightforward language: "Windmill can auto-fill script and flow inputs using AI" instead of verbose marketing copy