Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Technical Writing
Search
Sponsored
·
Ship Features Fearlessly
Turn features on and off without deploys. Used by thousands of Ruby developers.
→
Ruth Ikegah
February 27, 2021
Technology
1
130
Technical Writing
An introduction to Technical writing.
Ruth Ikegah
February 27, 2021
Tweet
Share
More Decks by Ruth Ikegah
See All by Ruth Ikegah
Spontaneous Career Growth in One Year
ruth_ikegah
1
70
Contributing Beyond Code
ruth_ikegah
0
82
How to overcome writer’s block as a beginner dev blogger
ruth_ikegah
0
58
Unveiling Secrets in contributing to Open Source
ruth_ikegah
0
56
Impact of Open Source to Career Development
ruth_ikegah
0
59
HOW TO USE GIT AND GITHUB
ruth_ikegah
0
93
The Growth Mindset
ruth_ikegah
0
70
A Beginner-inclusive Approach to Open-source
ruth_ikegah
0
51
Other Decks in Technology
See All in Technology
Blue/Green Deployment を用いた PostgreSQL のメジャーバージョンアップ
kkato1
0
160
SSoT(Single Source of Truth)で「壊して再生」する設計
kawauso
2
390
互換性のある(らしい)DBへの移行など考えるにあたってたいへんざっくり
sejima
PRO
0
250
DMBOKを使ってレバレジーズのデータマネジメントを評価した
leveragestech
0
440
PostgreSQL 18のNOT ENFORCEDな制約とDEFERRABLEの関係
yahonda
0
140
出版記念イベントin大阪「書籍紹介&私がよく使うMCPサーバー3選と社内で安全に活用する方法」
kintotechdev
0
100
AIエージェント×GitHubで実現するQAナレッジの資産化と業務活用 / QA Knowledge as Assets with AI Agents & GitHub
tknw_hitsuji
0
270
ブラックボックス化したMLシステムのVertex AI移行 / mlops_community_62
visional_engineering_and_design
1
220
Bref でサービスを運用している話
sgash708
0
200
ハーネスエンジニアリング×AI適応開発
aictokamiya
1
490
Sansanの認証基盤を支えるアーキテクチャとその振り返り
sansantech
PRO
1
110
OCI技術資料 : 証明書サービス概要
ocise
1
7.1k
Featured
See All Featured
Agile Leadership in an Agile Organization
kimpetersen
PRO
0
120
Designing for humans not robots
tammielis
254
26k
ピンチをチャンスに:未来をつくるプロダクトロードマップ #pmconf2020
aki_iinuma
128
55k
From π to Pie charts
rasagy
0
160
Utilizing Notion as your number one productivity tool
mfonobong
4
270
Facilitating Awesome Meetings
lara
57
6.8k
For a Future-Friendly Web
brad_frost
183
10k
How to Get Subject Matter Experts Bought In and Actively Contributing to SEO & PR Initiatives.
livdayseo
0
91
Git: the NoSQL Database
bkeepers
PRO
432
67k
New Earth Scene 8
popppiees
1
1.9k
[SF Ruby Conf 2025] Rails X
palkan
2
860
<Decoding/> the Language of Devs - We Love SEO 2024
nikkihalliwell
1
160
Transcript
Technical Writing
Ruth Ikegah Backend Developer Github Star Technical Writer About me?
What is Technical Writing Technical Writing is the practice of
creating a text- based instructional or informational document for helping people understand how to use a product or a service
Different types of Technical Documents Articles Product and API Documentation
Tutorials Guides and FAQ
Why write as a Dev? 01 Consolidates Learning
02 Educate others from your perspective
03 Visibility and Paid Opportunities
Practical Steps to start writing! 01 Choose a Niche
02 Choose a Platform: Hashnode, Devto, Self- hosted
03 Set a Schedule for Consistency
04 Get a topic and prepare a template
05 Share your content publicly
How to get Topic ideas? Look out for what others
are asking Document your learning Journey New concepts and technologies Hashnode Request for Articles
Useful Resources 01 Technical Writing Template 02 Pocket-Tech_Writing-List 03 Google
Technical Writing Course
03 How to Get Started in Technical Writing 04 Paid
Community Writing Programs
Technical Writing is a continuous process of learning, carefully gathering,
sifting, organizing, and accessing all while trying to craft something that makes sens for a user.
Contact Me @ikegahruth
[email protected]
https://cakebaby.dev/
Thanks for Listening!