Feed
Pro
Search

Sign in
FactoryKit - the AI software factory: tasks in, pull requests out Bug0 - The AI-native e2e QA regression testing The foreword by Hashnode - official blog from the Hashnode team Passmark - The open-source AI framework for regression testing Hashnode gql skill - let your AI agent publish to your Hashnode blog Hackathons Changelog Brand @hashnode on X Hashnode on LinkedIn Support - hello+support@hashnode.com Code of Conduct Terms Privacy Sitemap

Search Hashnode

Search posts, tags, users, and pages

Discussion on "Technical Writing 101 ⁠— Formatting Articles for Effective Communication" | Hashnode

FeedDiscussion

Nelson Michael

Front-end Engineer | Technical Writer

Jan 8, 2021

Technical Writing 101 ⁠— Formatting Articles for Effective Communication

Technical writing has become a big deal in the tech ecosystem. Whether you're writing documentation or just writing about some new cool technology you discovered, the ability to pass your message across precisely and effectively is key. In a bid to f...

nelsonmichael.hashnode.dev7 min read

#technical-writing-1 #blogging #web-development #documentation #programming

Responses(5)

Rob Chaves

Mar 15, 2021

Great reading! Thanks!

You're welcome! I'm glad it was.

Nelson Michael

Front-end Engineer | Technical Writer

Mar 16, 2021

Ashwin Sharma P

Loves to experiment with writing

Jan 9, 2021

Excellent article. Thanks for sharing 😀😀

Nelson Michael

Front-end Engineer | Technical Writer

Jan 9, 2021

My pleasure, I'm glad it was a good read

Victoria Lo

A nerd in books, tea, games and software.

Jan 8, 2021

Thanks for this enjoyable read! I love the ending quote:

"Comedy writers seek the funniest results, horror writers strive for the scariest, and technical writers aim for the clearest. In technical writing, clarity takes precedence over all other rules."

Is it your own words or are you quoting someone's?

Nelson Michael

Front-end Engineer | Technical Writer

Jan 8, 2021

Yaaaaay, I'm glad it was a good read. No it's a quote from Google's technical writing course,

developers.google.com/tech-writing/overview

Braydon Coyer

Sr Front End Developer, DOM Artist. https://braydoncoyer.dev/

Jan 8, 2021

Excellent. Great read! Thanks for sharing!

Nelson Michael

Front-end Engineer | Technical Writer

Jan 8, 2021

Thank you braydon, glad it was useful

Tapas Adhikary

Educator @tapaScript | Founder CreoWis & ReactPlay - Writer - YouTuber - Open Source

Jan 8, 2021

NELSON MICHAEL, Great tips! The hardest I dealt with is the Active voice VS Passive voice. I am still dealing with it, in fact.

Nelson Michael

Front-end Engineer | Technical Writer

Jan 8, 2021

Thank you Tapas, I'm glad it was useful.... Me too I dealt with the same problem, but that simple formula helped put everything In context for me.