Technical Writing for Software Engineers – A Handbook

Hacker News

About a month ago, I published a short essay on why engineers should focus on writing [0]. I've got very good feedback on that essay, and decided to compile all my knowledge and mistakes, about technical writing, into a short handbook. The purpose of this handbook, is to introduce engineers into technical writing through examples of 3 different technical documents: Design Review, Runbook, and General Technical Documents. For me, technical writing was one of the biggest boosts to my career. After being a good senior software engineer, the next boost I needed to become Tech Lead (and get on a path to become an architect)—was technical writing. I hope that my experience will help fellow engineers to improve their technical writing skills, and take their career to the next level. You can find more about the book on my blog[1], and purchase it on Gumroad[2] (there are some early bird copies left). Thank you! [0] https://www.yieldcode.blog/post/why-engineers-should-write/ [1] https://www.yieldcode.blog/book/technical-writing-for-softwa... [2] https://kudmitry.gumroad.com/l/technical-writing-for-softwar...

Visit product View on Hacker NewsAug 16, 2023

Share card

Actual performance

4points

Did not reach leaderboard

Launch Intel predictions

Analyze your own launch →

Indie HackersFits the IH revenue-focused audience · Strong signals: mistakes · Missing: supports, reddit linkedin, podcasting

72%72% predicted probability of success on Indie Hackers, based on ML models trained on real launch data.

best fitHighest predicted score across all platforms for this description.

Hacker NewsStrong engagement from HN community · Strong signals: ide, io · Missing: https docs, excited, just released

65%65% predicted probability of success on Hacker News, based on ML models trained on real launch data.

nativeThis product was originally launched on this platform.

Product HuntUnlikely to reach the leaderboard · Strong signals: code · Missing: mac, agents, macos

38%38% predicted probability of success on Product Hunt, based on ML models trained on real launch data.

TrustMRRLess likely to generate early MRR · Strong signals: month · Missing: mobile apps, ios, personal

34%34% predicted probability of success on TrustMRR, based on ML models trained on real launch data.

AppSumoMay struggle as an AppSumo deal · Missing: plus, platform, intuitive

32%32% predicted probability of success on AppSumo, based on ML models trained on real launch data.

Acquire.comPre-revenue stage for this audience · Missing: arr, mrr, revenue

12%12% predicted probability of success on Acquire.com, based on ML models trained on real launch data.

BetaListMay not resonate with beta-testers · Strong signals: introduce · Missing: web3, chat, crypto

0%0% predicted probability of success on BetaList, based on ML models trained on real launch data.

Incorrect prediction on native model

Similar products

Technical Writing for Software Engineers43%Launch Intel prediction score: how likely this product is to succeed on its source platform, based on its name, tagline, and description.

A Handbook to help you master technical writing as software

Indie Hackerscommitment-side-project

Replays of technical interviews with engineers from Google, FB and more59%Launch Intel prediction score: how likely this product is to succeed on its source platform, based on its name, tagline, and description.

Replays of technical interviews with engineers from Google, FB and more

Hacker News64

Sotto51%Launch Intel prediction score: how likely this product is to succeed on its source platform, based on its name, tagline, and description.

Helping software engineers ace technical interviews

Indie Hackerscommitment-side-project

Who's Writing Our Software?50%Launch Intel prediction score: how likely this product is to succeed on its source platform, based on its name, tagline, and description.

Who's Writing Our Software?

Hacker News1

JobAdScanner – Attract Better Software Engineers68%Launch Intel prediction score: how likely this product is to succeed on its source platform, based on its name, tagline, and description.

JobAdScanner – Attract Better Software Engineers

Hacker News5

MasterWriter64%Launch Intel prediction score: how likely this product is to succeed on its source platform, based on its name, tagline, and description.

Writing software | Songwriting software

Indie Hackersemployees-under-10

Engineers helping engineers ace every technical interview.44%Launch Intel prediction score: how likely this product is to succeed on its source platform, based on its name, tagline, and description.

Engineers helping engineers ace every technical interview.

Hacker News3

Draft.dev35%Launch Intel prediction score: how likely this product is to succeed on its source platform, based on its name, tagline, and description.

Technical content designed to reach software engineers

Indie Hackers4b2b

Who Pays Technical Writers (1.0)59%Launch Intel prediction score: how likely this product is to succeed on its source platform, based on its name, tagline, and description.

Who Pays Technical Writers (1.0)

Hacker News2

Docustore – Vectorized Technical Documentations54%Launch Intel prediction score: how likely this product is to succeed on its source platform, based on its name, tagline, and description.

Docustore – Vectorized Technical Documentations

Hacker News9

Browse all products Analyze your launch