Skip to content

Commit fe1a9ce

Browse files
martinbonninbenjie
andauthored
Update BLOG_STYLE_GUIDE.md
Co-authored-by: Benjie <[email protected]>
1 parent a9c0a96 commit fe1a9ce

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

BLOG_STYLE_GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Welcome to the GraphQL Blog Style Guide! This document outlines best practices a
88

99
## ✍️ General Writing Principles
1010

11-
- **Audience First**: Assume the reader has a technical background (developers, engineers) but may be new to GraphQL concepts.
11+
- **Audience First**: Think about who the audience of your post is. For release notes, you can assume some familiarity with the project. For other technical posts, you should typically assume the reader has a technical background (developers, engineers) but may be new to GraphQL concepts. For broader posts (case studies, events, grants, reports) avoid overly technical language.
1212
- **Clarity is Key**: Prioritize clear, concise explanations over jargon. Break down complex ideas with examples.
1313
- **Vendor neutral**: The GraphQL Blog is about GraphQL as a technology. Vendor specific content and personal promotion doesn't belong in the GraphQL blog.
1414

0 commit comments

Comments
 (0)