<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0">
<channel>
<title>Coder Legion - Recent posts tagged devjournal</title>
<link>https://coderlegion.com/tag/devjournal</link>
<description>Powered by Question2Answer</description>
<item>
<title>Would you use free assets in your games?</title>
<link>https://coderlegion.com/30611/would-you-use-free-assets-in-your-games</link>
<description>&lt;p&gt;&lt;strong&gt;&lt;em&gt;I would, and I don’t think there’s any shame in it.&lt;/em&gt;&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;I’ve never really understood the stigma around using free assets in game development. Sometimes, people talk about them as if downloading a free model or sound somehow makes the rest of your work less valuable.&lt;/p&gt;
&lt;p&gt;But why?&lt;/p&gt;
&lt;p&gt;For anyone unfamiliar with the term, assets are the individual things that go into a game: trees, buildings, characters, sounds, animations, textures, and so on. Making all of those takes time, and creating a game involves much more than making its individual parts.&lt;/p&gt;
&lt;p&gt;If someone offers a useful asset for free and allows others to use it, I see that as an opportunity.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;&lt;em&gt;Free doesn’t mean bad.&lt;/em&gt;&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The price of an asset doesn’t tell you whether it looks good, works properly, or fits your game. A paid model can be unsuitable for your project, while a free one can be exactly what you need.&lt;/p&gt;
&lt;p&gt;Some creators choose to share their work because they want to help other developers. Kenney, for example, makes its game assets available under CC0, allowing people to use them without requiring credit. These resources are offered for a reason: so people can build with them.&lt;/p&gt;
&lt;p&gt;There’s nothing embarrassing about accepting that help.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;&lt;em&gt;Your time matters, too.&lt;/em&gt;&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Imagine you need a simple chair for a room in your game. You could spend days learning how to model it, give it the right surface details, and get it working in the engine. Or you could find a suitable free chair and spend that time improving something the player will actually do.&lt;/p&gt;
&lt;p&gt;Neither choice is automatically wrong. If you want to learn how to make furniture, creating the chair yourself makes sense. If your goal is to finish a playable game, using an existing one might make more sense.&lt;/p&gt;
&lt;p&gt;Personally, I don’t think developers should feel pressured to spend days proving they can make an ordinary chair when their game needs attention elsewhere.&lt;/p&gt;
&lt;p&gt;That time could go towards a better mission, smoother movement, clearer menus, or fixing an annoying bug.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;&lt;em&gt;A downloaded asset doesn’t build the game for you.&lt;/em&gt;&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This is probably the part that gets overlooked most often.&lt;/p&gt;
&lt;p&gt;Downloading a door doesn’t make it open. You still need to decide how the player interacts with it, whether it needs a key, what happens when it’s locked, and how it connects to the rest of the game.&lt;/p&gt;
&lt;p&gt;Downloading trees doesn’t create an interesting forest. You still have to build the space, create paths, place things thoughtfully, adjust the lighting, and make sure the game runs well.&lt;/p&gt;
&lt;p&gt;The person who made the asset did valuable work. The person who turns it into part of a playable experience also does valuable work.&lt;/p&gt;
&lt;p&gt;Using someone else’s model doesn’t erase everything you built around it.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;You can use the same pieces and create something different.&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Two people can cook with the same ingredients and make very different meals. I think game assets work in a similar way.&lt;/p&gt;
&lt;p&gt;The same house model could become a peaceful home in one game and an abandoned building in another. Different lighting, sounds, surroundings, and events can completely change how that place feels.&lt;/p&gt;
&lt;p&gt;Custom artwork can certainly help a game stand out. But a game’s identity also comes from its ideas, its atmosphere, its story, and the way it plays.&lt;/p&gt;
&lt;p&gt;Every rock and table doesn’t need to be exclusive for the overall experience to feel personal.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Free assets help you find out whether an idea actually works.&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;An idea can sound amazing when you write it down and feel completely different once you try to play it.&lt;/p&gt;
&lt;p&gt;Having models, sounds, and animations available lets you reach that playable stage sooner. You can test a mechanic, try a different layout, or discover that something needs changing before spending months making everything yourself.&lt;/p&gt;
&lt;p&gt;And if a free asset still works well in the finished game, why replace it purely because it was free?&lt;/p&gt;
&lt;p&gt;I’d rather replace something because it doesn’t fit or causes problems, not because I feel guilty about how much it cost.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;&lt;em&gt;Not everyone has a studio’s budget.&lt;/em&gt;&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;A solo developer might be handling the gameplay, environments, menus, sound, testing, and writing. That’s already a lot for one person.&lt;/p&gt;
&lt;p&gt;They may not have the money to hire people for every task, or the years needed to become good at every part of development.&lt;/p&gt;
&lt;p&gt;Free assets make it easier for people to learn and give their ideas a real chance. They can also leave room in the budget for things that need special attention: perhaps an original main character, music, or an important location.&lt;/p&gt;
&lt;p&gt;Using free resources where they fit can help you afford custom work where it matters most.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;&lt;em&gt;Of course, you still need to choose carefully.&lt;/em&gt;&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;I’m not saying every free asset belongs in every game.&lt;/p&gt;
&lt;p&gt;Some won’t match the look you’re going for. Some might slow the game down or take too much effort to adjust. You also need to check what the creator allows you to do with them and give credit when required.&lt;/p&gt;
&lt;p&gt;And you should be honest about your contribution. Using someone’s model is fine when you have permission. Claiming you made that model yourself is a different issue.&lt;/p&gt;
&lt;p&gt;Those are fair things to discuss. But none of them makes using free assets shameful.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;&lt;em&gt;Judge the result.&lt;/em&gt;&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If a game looks messy, runs badly, or isn’t enjoyable, those are fair criticisms. Explain what isn’t working.&lt;/p&gt;
&lt;p&gt;Simply saying “that’s a free asset” doesn’t tell me what’s wrong with the game. Paying for the same object wouldn’t suddenly make the gameplay better.&lt;/p&gt;
&lt;p&gt;For me, the question is simple: does this asset fit what I’m making, and does using it help me move the project forward?&lt;/p&gt;
&lt;p&gt;If the answer is yes, I’m happy to use it.&lt;/p&gt;
&lt;p&gt;I respect people who create everything themselves. I also respect people who know where to spend their time and use the resources available to them.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;&lt;em&gt;So yes, I would use free assets in my game. Why should a useful resource become something to be ashamed of just because it didn’t cost money?&lt;/em&gt;&lt;/strong&gt;&lt;/p&gt;
</description>
<category>Discussions</category>
<guid isPermaLink="true">https://coderlegion.com/30611/would-you-use-free-assets-in-your-games</guid>
<pubDate>Sat, 10 Oct 2026 14:55:56 +0000</pubDate>
</item>
<item>
<title>What I Thought DevRel Was vs. What It Actually Is (A Mentee's Honest Take)</title>
<link>https://coderlegion.com/20024/what-i-thought-devrel-was-vs-what-it-actually-is-a-mentees-honest-take</link>
<description>&lt;p&gt;A few weeks ago, if you'd asked me what &quot;DevRel&quot; stood for, I would've squinted, smiled, and given you a confident-sounding non-answer. Today I'm in a DevRel mentorship program so let me close that knowledge gap for you the way it got closed for me&lt;/p&gt;
&lt;p&gt;The &quot;Before&quot;: What I Thought DevRel Was&lt;/p&gt;
&lt;p&gt;When I first heard the term Developer Relations (DevRel), my brain did what most people's brains do; it grabbed the two words and built a half-decent guess.&lt;br&gt;
&quot;Oh, so… you relate to developers? Like, customer support for developers?&quot;&lt;/p&gt;
&lt;p&gt;Not quite.&lt;/p&gt;
&lt;p&gt;&lt;img src=&quot;https://dev-to-uploads.s3.amazonaws.com/uploads/articles/kl5140ajz2u1idxzne34.png&quot; alt=&quot;Before vs After&quot;&gt;&lt;/p&gt;
&lt;p&gt;I also assumed it was basically being a tech influencer. Someone who posts on Twitter/X, shows up at events with a branded hoodie, and tells everyone how amazing their company's product is. Half marketing, half cheerleader.&lt;br&gt;
Also not quite.&lt;/p&gt;
&lt;p&gt;The &quot;During&quot;: What DevRel Actually Is&lt;/p&gt;
&lt;p&gt;Here's the cleanest definition I can give you:&lt;br&gt;
&lt;strong&gt;DevRel&lt;/strong&gt; is the bridge between a company that builds tools for developers and the developers who actually use those tools.&lt;/p&gt;
&lt;p&gt;Think of it like this: imagine a company builds a really powerful kitchen appliance, but only professional chefs can figure out how to use it. That appliance will flop; not because it's bad, but because nobody knows how to get value out of it. DevRel is the team that writes the cookbook, hosts the cooking class, listens to chefs complain about the buttons, and then walks back to the engineers and says, &quot;Hey, can we move this button?&quot;&lt;/p&gt;
&lt;p&gt;In tech, that &quot;appliance&quot; is usually an API, an SDK, or a developer tool. The &quot;chefs&quot; are software developers around the world. And DevRel is the function that makes sure the two actually connect.&lt;/p&gt;
&lt;p&gt;One thing my mentor said in our first session that stuck with me:&lt;br&gt;
&quot;You should be a developer(Even at beginner level) before you become a developer advocate.&quot;&lt;/p&gt;
&lt;p&gt;This is the part that demolished my &quot;tech influencer&quot; theory. You can't honestly bridge two worlds if you only live in one of them. If you've never written code, you don't know which parts of a product are confusing, broken, or magical. You can talk to developers, but you can't speak with them.&lt;/p&gt;
&lt;p&gt;The Three Cs of DevRel&lt;br&gt;
The work itself breaks down into three pillars what folks in the field call the 3 Cs:&lt;br&gt;
‍ &lt;strong&gt;Code&lt;/strong&gt; — DevRel folks build things. They use the product themselves, ship demo apps, write sample code, and feel the same friction real developers feel. This is how they earn the right to speak.&lt;br&gt;
✍ &lt;strong&gt;Content&lt;/strong&gt; — They turn the product into something learnable. Documentation, tutorials, blog posts, videos, livestreams, conference talks. If you've ever Googled &quot;how to do X with [some tool]&quot; and landed on a guide that actually made sense; that was probably DevRel's work.&lt;br&gt;
 &lt;strong&gt;Community&lt;/strong&gt; — They show up where developers gather. Hackathons, meetups, conferences like DevFest Lagos, Discord servers, Twitter/X spaces. They're not there to sell; they're there to listen, teach, and build genuine relationships.&lt;br&gt;
A DevRel person who only does one of the three? good but can be better. A DevRel person who weaves all three together? That's the real job.&lt;/p&gt;
&lt;p&gt;&lt;img src=&quot;https://dev-to-uploads.s3.amazonaws.com/uploads/articles/chu4stlz5ix5uxl2gqa0.png&quot; alt=&quot;The 3 Pillars of Developer Relations&quot;&gt;&lt;/p&gt;
&lt;p&gt;The &quot;After&quot;: How I'm Actually Getting Started&lt;/p&gt;
&lt;p&gt;I won't pretend I've figured this out. I'm at the very beginning; accepted into a mentorship program. But here's what &quot;getting started&quot; looks like in practice:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;&lt;p&gt;Becoming a developer first. Not optional. Before I can advocate for developers, I need to be one, even at a beginner level. Code is the foundation that everything else stands on.&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Learning from people already doing it. A few I'm watching closely:&lt;br&gt;
Tejas Kumar — chief developer advocate, podcast host, and one of the clearest voices on what DevRel actually is and isn't. His ConTejas Code podcast has a whole episode dedicated to a deep dive into DevRel.&lt;br&gt;
Sodiq Akinjobi — Developer Ecosystem Community Manager at Google and one of the organisers behind GDG Lagos and DevFest. If you want to see community-building done well in Africa, watch what he ships.&lt;br&gt;
Joshua Omobola  — a true polymath whose work cuts across engineering, writing, and community from Supertokens to Web3Afrika. The kind of multidisciplinary profile that DevRel rewards.&lt;br&gt;
Timonwa Akintokun — DevRel Engineer at IQ AI, working on ADK-TS (the Agent Development Kit for TypeScript). She literally sums up the job on her site as &quot;Code, content, and community that's what I do.&quot; Iconic. Also, a reminder that this field has space for women doing absolutely cracked work, and the more visible that is, the better.&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Putting myself out there. Which is what this blog post actually is. Writing in public is one of the best things you can do, you're practising content, learning to explain, and inviting feedback at the same time. (This is me practising.)&lt;/p&gt;
&lt;/li&gt;
&lt;/ol&gt;
&lt;p&gt;A Quick Word on Career Paths&lt;/p&gt;
&lt;p&gt;DevRel isn't one job; it's a family of jobs. You can specialise as a Developer Advocate, a Technical Writer, a Community Manager, a Developer Experience (DX) Engineer, or a DevRel Engineer. Some lean more toward code, some toward content, some toward people. There's no single ladder, which is intimidating at first but freeing once you accept it.&lt;/p&gt;
&lt;p&gt;So… What Do You Take From This?&lt;/p&gt;
&lt;p&gt;If you're a fellow developer wondering whether DevRel could be a fit, it is if you like teaching and you don't mind being visible.&lt;br&gt;
If you're non-tech and you've read this far, congratulations! You now understand a corner of tech that even a lot of tech people don't fully get. The next time someone says they work in DevRel, you'll know they're not doing tech support, and they're not just an influencer. They're the bridge.&lt;br&gt;
And if you're somewhere in between, welcome to the club. I'll see you out there!&lt;/p&gt;
&lt;p&gt;This post is part of my journey through the DX mentorship program. I'll be writing more as I learn. Feel free to follow along, or share your thoughts in the comments on what you thought DevRel was before reading this. I'm collecting answers!&lt;/p&gt;
</description>
<category>Articles</category>
<guid isPermaLink="true">https://coderlegion.com/20024/what-i-thought-devrel-was-vs-what-it-actually-is-a-mentees-honest-take</guid>
<pubDate>Tue, 09 Jun 2026 08:15:03 +0000</pubDate>
</item>
<item>
<title>Your RAG isn't broken. Your chunks are.</title>
<link>https://coderlegion.com/17860/your-rag-isnt-broken-your-chunks-are</link>
<description>&lt;p&gt;Everyone wants to blame the model. &quot;GPT-4 is hallucinating.&quot; &quot;Claude isn't following instructions.&quot; &quot;The embeddings are bad.&quot;Nine times out of ten, it's the chunks.I've been auditing RAG pipelines lately and the same patterns keep showing up:Fixed-size chunking that splits sentences in half. The model gets a fragment that starts with &quot;...and therefore the policy applies only when&quot; and you wonder why the answer is confidently wrong.No overlap between chunks. Context that spans a paragraph boundary is gone. The model sees the question but not the answer, because the answer lives in the chunk after the one that matched.Chunking before cleaning. Headers, nav menus, footer junk, and &quot;Click here to subscribe&quot; all get embedded as if they're content. Then they show up in retrieval and pollute the context window.Embedding the wrong thing. People embed the raw chunk but the user query is phrased completely differently. No wonder cosine similarity is low — they're not semantically close, they just happen to be about the same topic.Before you blame the model, look at what you're actually retrieving. Log the top 5 chunks for 10 real user queries and read them like a human. If you can't answer the question from those chunks, the model can't either.The model is a mirror. It reflects the quality of what you feed it.&lt;/p&gt;
</description>
<category>Articles</category>
<guid isPermaLink="true">https://coderlegion.com/17860/your-rag-isnt-broken-your-chunks-are</guid>
<pubDate>Thu, 14 May 2026 14:44:24 +0000</pubDate>
</item>
<item>
<title>Why I Started Taking Web Development More Seriously</title>
<link>https://coderlegion.com/15798/why-i-started-taking-web-development-more-seriously</link>
<description>&lt;p&gt;My interest in web development didn’t start with code; it started with curiosity.&lt;/p&gt;
&lt;p&gt;I used to look at different websites and wonder how everything worked behind the scenes. From simple layouts to complex features, it made me realize that there’s more than what we see as users. That curiosity slowly turned into a desire to understand and eventually create something on my own.&lt;/p&gt;
&lt;p&gt;As I learned more, I began to see how important websites are today. Almost every business, personal brand, or community relies on an online presence. That made me realize that web development is not just a technical skill, but something practical and valuable in the real world.&lt;/p&gt;
&lt;p&gt;What makes it even more interesting is the creative freedom. Building a website is not only about writing code, but it’s also about turning ideas into something real. &lt;em&gt;&lt;a rel=&quot;nofollow&quot; href=&quot;https://synnaulaid.github.io/blog/20260407/how-to-create-a-personal-page-for-free/&quot;&gt;Whether it’s a blog, a portfolio, or a simple web app, every project is an opportunity to experiment and improve.&lt;/a&gt;&lt;/em&gt;&lt;/p&gt;
&lt;p&gt;At the same time, I also discovered that this field is full of challenges. From understanding logic and algorithms to solving unexpected bugs, there’s always something to figure out. But instead of being frustrating, it became something I enjoy. The process of solving problems and learning from them is what keeps me going.&lt;/p&gt;
&lt;p&gt;In the end, learning web development is more than just a technical journey. It’s about curiosity, creativity, and continuous growth.&lt;/p&gt;
&lt;p&gt;If you’re curious about what led me to take this path more seriously, I shared the full story here: &lt;strong&gt;&lt;a rel=&quot;nofollow&quot; href=&quot;https://synnaulaid.github.io/blog/20260425/Kenapa-Saya-Mulai-Belajar-Lebih-Dalam-Soal-Website&quot;&gt;Why I Started Taking Web Development More Seriously&lt;/a&gt;&lt;/strong&gt;&lt;/p&gt;
</description>
<category>Articles</category>
<guid isPermaLink="true">https://coderlegion.com/15798/why-i-started-taking-web-development-more-seriously</guid>
<pubDate>Sat, 25 Apr 2026 07:07:30 +0000</pubDate>
</item>
<item>
<title>Beyond Code: Lessons from My Website Experience</title>
<link>https://coderlegion.com/15448/beyond-code-lessons-from-my-website-experience</link>
<description>&lt;p&gt;A website hiccup made me rethink how I approach projects, habits, and priorities. It's a reminder that growth isn’t just technical, it's personal too.&lt;br&gt;
Read the full reflection: &lt;strong&gt;&lt;a rel=&quot;nofollow&quot; href=&quot;https://synnaulaid.github.io/blog/20260422/Hal-hal-yang-Baru-Saya-Sadari-Setelah-Website-Kena-Masalah/&quot;&gt;Beyond Code: Lessons from My Website Experience&lt;/a&gt;&lt;/strong&gt;&lt;/p&gt;
</description>
<category>Articles</category>
<guid isPermaLink="true">https://coderlegion.com/15448/beyond-code-lessons-from-my-website-experience</guid>
<pubDate>Wed, 22 Apr 2026 03:33:00 +0000</pubDate>
</item>
<item>
<title>Technical Writing for Beginners: A Simple Guide with Examples</title>
<link>https://coderlegion.com/15430/technical-writing-for-beginners-a-simple-guide-with-examples</link>
<description>&lt;p&gt;Have you ever tried to follow instructions in a software program, only to end up more confused than when you started?&lt;/p&gt;
&lt;p&gt;This often happens when instructions are not written clearly or when too many technical terms are used without explanation. Good technical writing helps solve this problem by making complex information easier to understand.&lt;/p&gt;
&lt;p&gt;In this guide, you will learn what technical writing is, see practical examples, and discover a few simple tips to help you get started as a beginner technical writer.&lt;/p&gt;
&lt;hr&gt;
&lt;h3 id=&quot;what-is-technical-writing-&quot;&gt;What is Technical Writing?&lt;/h3&gt;
&lt;p&gt;Technical writing is the process of writing complex information into easy-to-understand content. However, the goal is not to sound complicated, but make things simple for the readers to understand.&lt;/p&gt;
&lt;h4 id=&quot;example&quot;&gt;Example&lt;/h4&gt;
&lt;p&gt;Instead of saying:  &lt;/p&gt;
&lt;blockquote&gt;&lt;p&gt;The application facilitates communication between users.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;A technical writer will write:  &lt;/p&gt;
&lt;blockquote&gt;&lt;p&gt;The app allows users to send messages to each other.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;In this example, the second sentence replaces the complex and formal terms &lt;em&gt;(facilitates, communication)&lt;/em&gt; in sentence one, with direct verbs &lt;em&gt;(allows, send)&lt;/em&gt;. This makes the information easier for readers to understand.&lt;/p&gt;
&lt;p&gt;The main goal of a technical writer is to turn complicated ideas into clear instructions that users can quickly follow.&lt;/p&gt;
&lt;hr&gt;
&lt;h3 id=&quot;other-examples&quot;&gt;Other Examples&lt;/h3&gt;
&lt;h4 id=&quot;topic-1-how-to-install-a-mobile-app&quot;&gt;Topic 1: How to Install a Mobile App&lt;/h4&gt;
&lt;h5 id=&quot;complex-example&quot;&gt;Complex Example&lt;/h5&gt;
&lt;blockquote&gt;&lt;p&gt;After downloading the application, execute the installation procedure and configure the settings appropriately.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;This sounds too complex and unclear.&lt;/p&gt;
&lt;h5 id=&quot;simple-technical-writing-example&quot;&gt;Simple Technical Writing Example&lt;/h5&gt;
&lt;h4 id=&quot;how-to-install-the-app&quot;&gt;How to Install the App&lt;/h4&gt;
&lt;ol&gt;
&lt;li&gt;Open the Google Play Store  &lt;/li&gt;
&lt;li&gt;Search for the app name  &lt;/li&gt;
&lt;li&gt;Tap &lt;strong&gt;Install&lt;/strong&gt;  &lt;/li&gt;
&lt;li&gt;Wait for the download to finish  &lt;/li&gt;
&lt;li&gt;Open the app and follow the setup instructions  &lt;/li&gt;
&lt;/ol&gt;
&lt;p&gt;This version works for three reasons:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;It uses numbered steps so readers can track their progress  &lt;/li&gt;
&lt;li&gt;It uses plain, active verbs &lt;em&gt;(tap, search, open)&lt;/em&gt; instead of vague ones &lt;em&gt;(execute, configure)&lt;/em&gt;  &lt;/li&gt;
&lt;li&gt;It speaks directly to the reader using &quot;you&quot;  &lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;These three habits: numbered steps, active verbs, second person voice are cornerstones of good technical writing.&lt;/p&gt;
&lt;hr&gt;
&lt;h4 id=&quot;topic-2-connecting-to-wi-fi&quot;&gt;Topic 2: Connecting to Wi-Fi&lt;/h4&gt;
&lt;h5 id=&quot;complex-example-1&quot;&gt;Complex Example&lt;/h5&gt;
&lt;blockquote&gt;&lt;p&gt;Establish a wireless network connection by opening the device network configuration interface, selecting the desired SSID and providing the correct security credentials.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;h5 id=&quot;simple-technical-writing-example-1&quot;&gt;Simple Technical Writing Example&lt;/h5&gt;
&lt;blockquote&gt;&lt;p&gt;Open Settings → Wi-Fi, select your network, enter the password and tap Connect.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;The other example is preferable because it changed the technical jargon &lt;em&gt;(establish, configuration, desired SSID)&lt;/em&gt; used to relatable verbs &lt;em&gt;(open, select, enter)&lt;/em&gt;. This process compressed the first example into simple instructions, which is the purpose of technical writing.&lt;/p&gt;
&lt;hr&gt;
&lt;h3 id=&quot;where-technical-writing-is-used&quot;&gt;Where Technical Writing Is Used&lt;/h3&gt;
&lt;p&gt;Technical writing is used in many areas of technology, such as:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;&lt;p&gt;&lt;strong&gt;Software Documentation&lt;/strong&gt;&lt;br&gt;
These are guides that explain how software works and how to use it.&lt;br&gt;
&lt;em&gt;Example: A guide explaining how to use Microsoft Word or Zoom features.&lt;/em&gt;&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;&lt;strong&gt;Product Manuals&lt;/strong&gt;&lt;br&gt;
Step-by-step instructions for setting up or using a product.&lt;br&gt;
&lt;em&gt;Example: A phone or blender manual.&lt;/em&gt;&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;&lt;strong&gt;Tutorials and Guides&lt;/strong&gt;&lt;br&gt;
Instructions that teach users how to complete a task.&lt;br&gt;
&lt;em&gt;Example: How to create a Gmail account.&lt;/em&gt;&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;&lt;strong&gt;Instructions for Developers&lt;/strong&gt;&lt;br&gt;
Instructions on how to use software tools, apps, or services.&lt;br&gt;
&lt;em&gt;Example: Using an API.&lt;/em&gt;&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;&lt;strong&gt;Help Center Articles&lt;/strong&gt;&lt;br&gt;
Short articles that answer common questions or solve problems.&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;&lt;strong&gt;Technical Blog Posts&lt;/strong&gt;&lt;br&gt;
Articles that explain technical topics in a simple way.&lt;/p&gt;
&lt;/li&gt;
&lt;/ol&gt;
&lt;hr&gt;
&lt;h3 id=&quot;tools-used-for-technical-writing&quot;&gt;Tools Used for Technical Writing&lt;/h3&gt;
&lt;p&gt;When starting technical writing, some tools can make the process easier.&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;&lt;p&gt;&lt;strong&gt;Markdown&lt;/strong&gt;&lt;br&gt;
A simple formatting language used for writing structured documents.&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;&lt;strong&gt;Google Docs&lt;/strong&gt;&lt;br&gt;
Useful for drafting articles, editing content and collaborating.&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;&lt;strong&gt;Grammarly&lt;/strong&gt;&lt;br&gt;
Helps check grammar, spelling and clarity.&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;&lt;strong&gt;Notion&lt;/strong&gt;&lt;br&gt;
Helpful for organizing notes and writing ideas.&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;&lt;strong&gt;Hashnode&lt;/strong&gt;&lt;br&gt;
A platform for writing and publishing technical blogs.&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;&lt;strong&gt;Confluence&lt;/strong&gt;&lt;br&gt;
Used by companies for internal documentation.&lt;/p&gt;
&lt;/li&gt;
&lt;/ol&gt;
&lt;blockquote&gt;&lt;p&gt;If you're just starting out, begin with Google Docs and Grammarly. You can learn the others as you grow.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;hr&gt;
&lt;h3 id=&quot;tips-for-beginners&quot;&gt;Tips for Beginners&lt;/h3&gt;
&lt;h4 id=&quot;1-audience-awareness&quot;&gt;1. Audience Awareness&lt;/h4&gt;
&lt;p&gt;Before you write a single sentence, ask yourself:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Who will read this?  &lt;/li&gt;
&lt;li&gt;What do they already know?  &lt;/li&gt;
&lt;li&gt;What do they need to be able to do after reading this?  &lt;/li&gt;
&lt;li&gt;What is the simplest way to explain this?  &lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;Knowing your audience is what separates useful technical writing from writing that just sounds technical.&lt;/p&gt;
&lt;hr&gt;
&lt;h4 id=&quot;2-start-with-easy-topics&quot;&gt;2. Start with Easy Topics&lt;/h4&gt;
&lt;p&gt;Begin by picking simple tasks like:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;How to reset a password  &lt;/li&gt;
&lt;li&gt;How to send an email  &lt;/li&gt;
&lt;/ul&gt;
&lt;hr&gt;
&lt;h4 id=&quot;3-avoid-hard-words&quot;&gt;3. Avoid Hard Words&lt;/h4&gt;
&lt;p&gt;Use simple words everyone can understand.&lt;/p&gt;
&lt;p&gt;Instead of:  &lt;/p&gt;
&lt;blockquote&gt;&lt;p&gt;Authenticate your credentials  &lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;Write:  &lt;/p&gt;
&lt;blockquote&gt;&lt;p&gt;Enter your username and password  &lt;/p&gt;
&lt;/blockquote&gt;
&lt;hr&gt;
&lt;h4 id=&quot;4-use-headings-and-lists&quot;&gt;4. Use Headings and Lists&lt;/h4&gt;
&lt;p&gt;Break your content into headings and lists.&lt;/p&gt;
&lt;h5 id=&quot;example-how-to-take-a-screenshot&quot;&gt;Example: How to Take a Screenshot&lt;/h5&gt;
&lt;ul&gt;
&lt;li&gt;Press the Power and Volume Down buttons together  &lt;/li&gt;
&lt;li&gt;Wait for the screen to flash  &lt;/li&gt;
&lt;li&gt;Open your gallery to view the screenshot  &lt;/li&gt;
&lt;/ul&gt;
&lt;hr&gt;
&lt;h4 id=&quot;5-give-examples&quot;&gt;5. Give Examples&lt;/h4&gt;
&lt;p&gt;Show how things work with short examples. Use step-by-step instructions or screenshots to improve understanding.&lt;/p&gt;
&lt;hr&gt;
&lt;h4 id=&quot;6-practice-writing&quot;&gt;6. Practice Writing&lt;/h4&gt;
&lt;p&gt;Write short, simple guides regularly.&lt;/p&gt;
&lt;p&gt;Create a mini-guide like:  &lt;/p&gt;
&lt;blockquote&gt;&lt;p&gt;How to share a file online  &lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;Try publishing it on a blog.&lt;/p&gt;
&lt;hr&gt;
&lt;h3 id=&quot;conclusion&quot;&gt;Conclusion&lt;/h3&gt;
&lt;p&gt;Practicing technical writing helps you communicate clearly, think logically, and solve problems step by step. It also builds a portfolio that shows your skills to potential employers or collaborators.&lt;/p&gt;
&lt;p&gt;Start small. Pick any app or tool you use daily and write a step-by-step guide explaining how to use it.&lt;/p&gt;
&lt;p&gt;Share it on dev.to and tag it &lt;strong&gt;#technicalwriting&lt;/strong&gt;. The feedback you receive will accelerate your growth faster than writing in private.&lt;/p&gt;
&lt;p&gt;The more you practice explaining technical topics clearly and simply, the better you will become.&lt;/p&gt;
</description>
<category>Articles</category>
<guid isPermaLink="true">https://coderlegion.com/15430/technical-writing-for-beginners-a-simple-guide-with-examples</guid>
<pubDate>Tue, 21 Apr 2026 21:07:57 +0000</pubDate>
</item>
</channel>
</rss>