DEV Community

Cover image for #DEVDiscuss: Ultimate Tips for Writing Technical Content
Erin Bensinger for The DEV Team

Posted on

11 1 1

#DEVDiscuss: Ultimate Tips for Writing Technical Content

Time for #DEVDiscuss — right here on DEV 😎

Inspired by @blackgirlbytes's Top 7 post, tonight’s topic is...ultimate tips for writing technical content!

Based on her experience as a Developer Advocate, Rizèl Scarlett has written an incredible, comprehensive guide to writing technical content — seriously, take a look 👀

So let's talk about it!

Questions:

  • Which of the points in the ultimate guide have served you well as a technical content writer?
  • What are your top tips for writing technical content? Where or how did you learn them?
  • Any triumphs, fails, or other stories you'd like to share on this topic?

Top comments (2)

Collapse
 
cbid2 profile image
Christine Belzie
  1. What are your top tips for writing technical content? Where or how did you learn them?
    My answer: Through a few wise individuals in a tech Twitter Space on content creation, I learned that the topics people write about is not always. Creators in some fashion speak out about the same thing. What gets people to read your tech content are the following:

  2. Its presentation

  3. The level of popularity you have (this can be debateable)

  4. Which of the points in the ultimate guide have served you well as a technical content writer?
    My answer: Writing tech blog posts is only one aspect of writing tech content. It's important to have some form of knowledge on how to maintain a product's documentation. Note: I am aware the focus is on writing technical content, but I've noticed and used to think that creating technical blog posts is often seen as the only way to gain experience to become a technical writer.

Collapse
 
shiffletts38788 profile image
Shifflettson Niccum

Ultimate Tips for Writing Technical Content include focusing on clarity, accuracy, and simplicity, ensuring that your audience can easily understand complex concepts. Break down the content into digestible sections, use clear headings, and provide real-world examples to make the material relatable. Additionally, avoid jargon unless absolutely necessary, and make sure to proofread your work for any errors. For instance, when writing about app features, like the Scarlet iOS app, clearly explain its functionality, benefits, and how users can download it, helping your audience grasp the value easily while maintaining technical precision.

DEV is built on open source software called Forem!

GitHub logo forem / forem

For empowering community 🌱


Forem 🌱

For Empowering Community

Build Status Build Status GitHub commit activity GitHub issues ready for dev GitPod badge

Welcome to the Forem codebase, the platform that powersdev.to. We are so excited to have you. With your help, we canbuild out Forem’s usability, scalability, and stability to better serve ourcommunities.

What is Forem?

Forem is open source software for building communities. Communities for yourpeers, customers, fanbases, families, friends, and any other time and spacewhere people need to come together to be part of a collectiveSee our announcement postfor a high-level overview of what Forem is.

dev.to (or just DEV) is hosted by Forem. It is a community ofsoftware developers who write articles, take part in discussions, and buildtheir professional profiles. We value supportive and constructive dialogue inthe pursuit of great code and career growth for all members. The ecosystem spansfrom beginner to advanced developers, and all are welcome to find their place…

👋 Kindness is contagious

Engage with a sea of insights in this enlightening article, highly esteemed within the encouraging DEV Community. Programmers of every skill level are invited to participate and enrich our shared knowledge.

A simple "thank you" can uplift someone's spirits. Express your appreciation in the comments section!

On DEV, sharing knowledge smooths our journey and strengthens our community bonds. Found this useful? A brief thank you to the author can mean a lot.

Okay