Skip to Content

Writing

Writing

2 posts

Writing for Developers: Blogs that get read

Writing for Developers: Blogs that get read by Piotr Sarna and Cynthia Dunlop is about, you guessed it, writing for developers. While it is full of practical tips that can apply to any technical writer, the book is focused on writing technical blogs.

This book is packed full of information about writing a technical blog post, including going through the draft process, polishing your post, getting feedback, publishing, and even following up.

To be honest, while I found the book easy to read, I skipped over parts that didn't interest me or were already familiar. It's a good book to

Document your work!

Documentation is vital for software developers. It boosts understanding, ensures thoroughness, improves collaboration, and saves future time and effort.

Please document your work! I’m speaking from the context of a software developer/architect, but this also applies elsewhere.

Currently, it may feel like a waste of time. You may think, “I’ll remember this.” or “I’ll never do this again.” I’ve been there (and still think this). However, documenting has so many advantages. I’m pushing myself to do better at it constantly. More documentation with less effort.

Creating documentation is a great way to go through whatever it is in greater detail and ensure you don’t miss anything. I can’t count how many