Writing a technical blog

Technical editing — someone, usually a technologist, who is willing to walk through the examples, samples, and demo code to verify it works and there are no missing steps.

Books are more than just words. Most likely you will include code, images and possibly video in your blog post. Use analogies and examples Do you see what I did above?

How To Write Technical Blog Posts

An analogy is a comparison between two things — it explains a concept in terms that your readers will understand. He is easily distracted by cute kitten videos.

Another great writing tool for blogs is the analogy. In my case, these tasks are stored in OmniFocus within a project created specifically for this blog post. Whatever workflow you choose to implement, take the time to document it. Expand acronyms and abbreviations; this helps with SEO too.

Step 3 — Writing The author writes or authors write the first draft. Writing a technical blog gave you an example of how overly sophisticated writing can stop your business blog from doing its job.

Step 4 — Editing Editing involves at least a couple phases: Here are a few ideas to get you going: Let your co-workers know about the post and encourage them to interact Post to the following social websites those that make sense for your particular post: Via all sorts of hackery, of course.

Sometimes, all you need is a link to another post with some context added in. In TextMate I preview the Markdown and make my final edits. Keep paragraphs short to make the content easier to read. What is the one single message I want to convey?

What impression of me does the blog post convey? Without a clear idea in my head about the person for whom I am writing, it can be difficult to decide what and how to write. For technical books, this includes screen shots and code snippets.

Use bullets and numbers to make individual points and give step-by-step instructions. Use the Natural Planning Method When I write a technical blog post, the goal is to create something that saves the reader time and inspires new ideas.

There are images and code to consider. Get into the habit of doing this for others as well. Simplified" by improving the lives of developers, both internally and externally.

When writing a technical book, typesetting takes time to do well. Some examples of analogies: Editing takes time to do well when writing a technical book. The preview will auto-update as Scrivener auto-saves.

That last sentence is pregnant… As an author, you want to make sure you are comfortable with the contract when writing a technical book. What works for you? Your headline and sub-headlines should tell a compelling story in and of themselves, but they should also encourage the reader to read the content underneath.

Though all of the teams involved in those Web projects — marketers, designers, developers, copywriters, even clients — spoke English, they all seemed to have very different dialects. Unsubscribe at any time. I suggest that you a timebox this step and b use resources beyond simple Google searches.

Follow his exploits on Twitter and GitHub. For whom am I writing? At this point, we take our purpose, objectives, brainstorm, and research and transform that information into an outline. At its heart, the contract is the work-for-remuneration document.5 Tips for Writing Blogs About Technical or Complex Topics Blogging, Writing techniques I fell into the role of Web project manager pretty early in my career because I had a knack for “translating” between different business teams.

How to write good technical blog posts Posted on January 12, June 29, by Matthew Skelton (@matthewpskelton) I have been writing technical blog posts sincebut decided in late to change my writing style after undertaking various web content and SEO projects for clients and seeing the effects of good (and bad) writing.

"It's definitely a balancing act," says Jason Olson, who writes Managed World, a blog billed as "another blog by yet another geek." What's more, you've got lots of competition.

"Even in the technical world, there seems to be an overabundance of blogs," Olson says.

Top 25 Technical Writing blogs

A list of the top blogs in the Technical Writing category based on 20+ different factors including RSS membership, Number of incoming links, social media, monthly visits. How To Write Technical Blog Posts Elmer Thomas March 27, • 8 min read I love technical blog posts, especially those that can take you through the entire process of building an app, A to Z.

In this, the first part of of the series, we’ll talk about how to get started as a technical writer: overcoming mental resistance, generating ideas, and starting with your audience in mind. Get Psyched Up. Figuring out how to write a technical blog post can be overwhelming if you’re not used to it.

Many people find it hard to choose a topic.

Download
Writing a technical blog
Rated 4/5 based on 74 review