Skip to content

Commit db4cd92

Browse files
committed
reshuffle the "audience first" part a bit
1 parent 7f250d0 commit db4cd92

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

BLOG_STYLE_GUIDE.md

Lines changed: 5 additions & 2 deletions
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**: 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.
11+
- **Audience First**: Think about who the audience of your post is.
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

@@ -43,7 +43,10 @@ This list is non-exhaustive. If there is something you would like to see on the
4343
### Introduction
4444

4545
- Hook the reader in 1–2 sentences.
46-
- Set clear expectations about what the post covers and who it's for.
46+
- Set clear expectations about what the post covers and who it's for:
47+
- open source users of a given project (release notes, updates,...) are probably already familiar with the tool.
48+
- technical users (best practices, working group updates) have a technical background but may be new to GraphQL concepts.
49+
- larger audience (case studies, events, grants, reports) may not necessarily have a technical background but still be interested in latest GraphQL content.
4750

4851
### Body
4952

0 commit comments

Comments
 (0)