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
Readability + structure for long-form technical content — blog posts, concept explainers, and
65
66
capability overviews people actually finish reading. Use when drafting or revising a prose article
66
67
that feels dense, or for a scannability/voice/structure pass: reader-first framing, text chunking,
67
-
the inverted pyramid, headline patterns, intro/conclusion anatomy. For SEO/frontmatter facts see
68
-
[[blog-seo-standards]]; for numbered walkthroughs [[tutorial-writing]].
68
+
the inverted pyramid, headline patterns, intro/conclusion anatomy, and calibrating content depth to
69
+
the reader (runnable specifics for developers, trade-offs and rationale for architects). For
70
+
SEO/frontmatter facts see [[blog-seo-standards]]; for numbered walkthroughs [[tutorial-writing]].
69
71
---
70
72
71
73
# Technical content structure
@@ -148,6 +150,26 @@ sec") instead of claiming it "makes things easier." Describing a chat-style inte
148
150
real exchange (`You:` / `Assistant:` turns in a fenced block), not narration of what a reader *might*
149
151
type — an actual transcript feels concrete.
150
152
153
+
## Match the depth to who's reading: developers vs. architects
154
+
155
+
A technical piece earns its reader's time differently depending on who they are, and the two audiences judge it on opposite things. Decide up front whether you're writing for the person who will *build* the thing or the person who decides *whether* it should be built, then pressure-test the draft against that reader's bar.
156
+
157
+
**For developers, abstract prose is dead weight** — they came for something they can run.
158
+
159
+
- A section that stays conceptual with no code, API call, or command is one they scroll straight past. Ground each one in a snippet that actually executes.
160
+
- "Check the docs" is a dead end unless you name the exact page, class, or method — point at the precise thing, not the manual.
161
+
- When the topic touches data operations, cover the platform's limits, batch/bulk handling, and the error paths; leaving those out reads as inexperience and costs you trust.
162
+
- Don't sketch a pattern only in the abstract — show the real implementation (the class, the component, the endpoint) underneath it.
163
+
- Cut vague instructions like "call the appropriate method" or "handle errors as needed"; name the method and the specific error type instead.
164
+
165
+
**For architects, the *why* carries as much weight as the *what*** — they're weighing a decision, not copying steps.
166
+
167
+
- A flat recommendation with no trade-offs is half an answer. Say when the alternative is the better call, too.
168
+
- Give the reasoning behind a design, not just the build order — the rationale is the part they read for.
169
+
- For any integration or system-design pattern, address data volume, the sync-versus-async choice, and what happens when it fails; skip those three and the piece feels shallow.
170
+
- "This scales well" is an empty claim without a number or a named breaking point behind it.
171
+
- Recommending one option means comparing it to the realistic alternatives — name the competitors and why you passed on them. A recommendation with no rivals on the page is an assertion, not a decision.
172
+
151
173
## Keep your labels consistent
152
174
153
175
Once a post falls into a repeating pattern, **word that element identically every time** — the
@@ -181,6 +203,7 @@ rows, intro/outro summaries, an "as noted above"). A heading has to match whatev
181
203
-[ ] No paragraph over four sentences; something visual every few hundred words; two-plus real visuals
182
204
-[ ] Opening covers the five W's and ends with a quick roadmap
183
205
-[ ] Every section leads with its point (inverted pyramid), pain before fix
206
+
-[ ] Depth matches the reader — runnable code + specifics for developers, trade-offs + rationale for architects
184
207
-[ ] Links inline behind real labels; lists used only where they fit
185
208
-[ ] Conclusion lands on the value and points to a next step (not a recap)
186
209
-[ ] SEO handled separately → [[blog-seo-standards]]
0 commit comments