Skip to content

Commit cfecc6e

Browse files
claude[bot]rubenfiszelcentdixhcourdent
authored
[Claude PR] Add claude_feedbacks.md for writing style feedback (#1008)
* internal: add claude_feedbacks.md for writing style feedback - Create claude_feedbacks.md to collect raw feedback about Claude's writing style - Update CLAUDE.md to reference feedback file before writing new docs - Add first feedback about avoiding overly marketing language Co-authored-by: Ruben Fiszel <[email protected]> * Update CLAUDE.md * fix * fix * adjust * Update writing_style_guide.md Sentence case --------- Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com> Co-authored-by: Ruben Fiszel <[email protected]> Co-authored-by: centdix <[email protected]> Co-authored-by: centdix <[email protected]> Co-authored-by: Henri Courdent <[email protected]>
1 parent 2e919d5 commit cfecc6e

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ These guidelines ensure consistency and quality when writing or modifying Windmi
55
## Content
66

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

910
## File structure and naming
1011

writing_style_guide.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Claude writing style guide
2+
3+
This file contains writing style guidance when creating Windmill documentation. Review this guide before writing new documentation.
4+
5+
## General writing style issues
6+
7+
### Overly marketing language
8+
9+
**Problem example:**
10+
"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."
11+
12+
**Issues:**
13+
14+
- Too long and verbose for technical documentation
15+
- Marketing language like "This intelligent feature" sounds promotional rather than technical
16+
- Users prefer concise, direct explanations over flowery descriptions
17+
18+
**Better approach:**
19+
20+
- Keep descriptions short and technical
21+
- Focus on what the feature does, not how "intelligent" or "smart" it is
22+
- Use straightforward language: "Windmill can auto-fill script and flow inputs using AI" instead of verbose marketing copy

0 commit comments

Comments
 (0)