Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Tips for Writing Great Technical Content

Jessica Temporal
September 17, 2021
Technology
0
190

Tips for Writing Great Technical Content

Jessica Temporal

September 17, 2021
Tweet

More Decks by Jessica Temporal

See All by Jessica Temporal
Traveling Through a Secure API with Python and Auth0
jtemporal
0
110
Rosie, Robot
jtemporal
0
430
Meet Rosie
jtemporal
0
62
Serenata de Amor's data science
jtemporal
1
170
Final Graduation Project
jtemporal
0
210

Other Decks in Technology

See All in Technology
DIってなんだか難しい？ 依存という概念を「使う・使われる」 という言葉で整理しよう
akinoriakatsuka
1
730
これからクラウドエンジニアになるために本当に必要なスキル 5選
hiyanger
1
440
AWSにおけるサイバー攻撃の傾向と具体的な対策
yuobayashi
8
790
DevinはクラウドエンジニアAIになれるのか!? 実践的なガードレール設計/devin-can-become-a-cloud-engineer-ai-practical-guardrail-design
tomoki10
2
890
SLI/SLO・ラプソディあるいは組織への適用の旅
nwiizo
4
1.1k
PostgreSQL Unconference #52 pg_tde
nori_shinoda
0
120
Reactを段階的に覗いてみる
ytaisei
2
840
チームの性質によって変わる ADR との向き合い方と、生成 AI 時代のこれから / How to deal with ADR depends on the characteristics of the team
mh4gf
4
280
大規模プロジェクトにおける 品質管理の要点と実践 / 20250327 Suguru Ishii
shift_evolve
0
190
SpannerとAurora DSQLの同時実行制御の違いに想いを馳せる
masakikato5
0
470
ClineにNext.jsのプロジェクト改善をお願いしてみた / 20250321_reacttokyo_LT
optim
1
1.1k
Amazon Q Developer 他⽣成AIと⽐較してみた
takano0131
1
110

Featured

See All Featured
Music & Morning Musume
bryan
46
6.4k
Navigating Team Friction
lara
183
15k
KATA
mclloyd
29
14k
Designing Dashboards & Data Visualisations in Web Apps
destraynor
231
53k
実際に使うSQLの書き方 徹底解説 / pgcon21j-tutorial
soudai
176
52k
Side Projects
sachag
452
42k
Documentation Writing (for coders)
carmenintech
69
4.7k
Reflections from 52 weeks, 52 projects
jeffersonlam
349
20k
Typedesign – Prime Four
hannesfritz
41
2.6k
Java REST API Framework Comparison - PWX 2021
mraible
29
8.5k
Into the Great Unknown - MozCon
thekraken
35
1.7k
Sharpening the Axe: The Primacy of Toolmaking
bcantrill
40
2k

Transcript

  1. auth0.com Tips for Writing Technical Content Content Hackathon 1

  2. auth0.com 2 Hello o/ @jesstemporal

  3. auth0.com 3 Writing

  4. auth0.com 4 Be Concise

  5. auth0.com 5 Define Your Audience

  6. auth0.com 6 Minimize Sentence Length

  7. auth0.com 7 Always spell check

  8. auth0.com 8 Read it out loud

  9. auth0.com 9 Structure

  10. auth0.com 10 Define Any Prerequisites

  11. auth0.com 11 Define Learning Outcomes

  12. auth0.com 12 Create Clear Headers

  13. auth0.com 13 Include a Table of Contents

  14. auth0.com 14 Use Bullet Points

  15. auth0.com 15 Use Images/Gifs

  16. auth0.com 16 Include Real Code Snippets (not images)

  17. auth0.com 17 Add a CTA

  18. auth0.com 22 See you soon o/ @jesstemporal