You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: BLOG_STYLE_GUIDE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Welcome to the GraphQL Blog Style Guide! This document outlines best practices a
8
8
9
9
## ✍️ General Writing Principles
10
10
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.
12
12
-**Clarity is Key**: Prioritize clear, concise explanations over jargon. Break down complex ideas with examples.
13
13
-**Vendor neutral**: The GraphQL Blog is about GraphQL as a technology. Vendor specific content and personal promotion doesn't belong in the GraphQL blog.
0 commit comments