Technical Blog Post Writing Style Checklist
•Als PPT, PDF herunterladen•
0 gefällt mir•425 views
The document provides a checklist for improving the writing style of technical blog posts. It emphasizes the importance of grabbing readers' attention with compelling titles and openings. It also stresses establishing authority, communicating benefits clearly, using stories, keeping content concise and easy to understand, and reviewing drafts carefully before publishing. The checklist covers getting attention, establishing authority, style and format, and review.
![Startupping ,[object Object],[object Object]](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)
Empfohlen
Weitere ähnliche Inhalte
Was ist angesagt?
Was ist angesagt? (20)
Andere mochten auch
Andere mochten auch (20)
Ähnlich wie Technical Blog Post Writing Style Checklist
Ähnlich wie Technical Blog Post Writing Style Checklist (20)
Mehr von Pietro Polsinelli
Mehr von Pietro Polsinelli (19)
Kürzlich hochgeladen
Kürzlich hochgeladen (20)
Technical Blog Post Writing Style Checklist
- 1. Improving the writing style of technical blog posts For Developers in Florence 01 3rd March 2010 - http://www.open-lab.com/diff01
- 9. Coding Horror The Great Newline Schism. The topic of this post is newline invisible characters, and this post topic is probably on one of the most uninteresting topic ever . Atwood is indeed engaged in narration: “ The Carriage Return (CR) and Line Feed (LF) terms derive from manual typewriters, and old printers based on typewriter-like mechanisms (typically referred to as “Daisywheel” printers).”
- 10. Seth’s blog
- 12. Design for beauty or readability? These are incredible designers that create a different design for each blog post . But as said above, our idea is to excite the reader with narration, not with novel design, as we want the reader to focus on contents . So pick a simple, highly readable, consistent layout for your blog and stick to it.
- 13. Writing
Hinweis der Redaktion
- Why few blogs are very popular, and most are practically ignored? You may believe that popularity is simply a question of luck or money. I read many blogs for professional reasons, and some among these are a real pleasure to read. Well, it also happens that the well-written ones are the most popular among the ones I read, and being well written may be what explains their success, at least partially. So in what follows I do some analysis of writing styles and then define a checklist which you may use to analyze your own blog drafts before publishing them, eventually improving your writing . Most popular blogs are “well written”: by this I don’t (just) mean grammatically correct, I mean well written by looking at them as sort of short stories . Looking at blog posts in this way is a perspective that probably escapes technical writers; it is obvious for anybody who has copywriting experience. A blog can be very well written and not be popular, and there may even be popular blogs that are badly written, but there seems to be enough correlation with “good writing” for blogs that have contents as good as those of many others but stand out in popularity. Now we will examine three popular blogs, to see some writing techniques in action. Then we will try to define some rules to improve your blog’s writing. I will not go into why having a popular blog can be important, I just assume that it is so – a discussion would lead us to an entirely different topic. What is here said about writing is contextualized to blogs, but I believe can be a help in any kind of copywriting activity.
- Joel even says that ANY story goes, even a fake start…
- Joel even says that ANY story goes, even a fake start…
- Reading it is a pleasure anyway because of the way Atwood evokes old typewriters and nice pictures to lead the reader along; he is not telling a story in a classical sense, but he is indeed engaged in narration:
- Reading it is a pleasure anyway because of the way Atwood evokes old typewriters and nice pictures to lead the reader along; he is not telling a story in a classical sense, but he is indeed engaged in narration:
- His posts are filled with anthropological observations: he manages to link to the readers’ emotions. He has a talent for finding latent emotional roots in apparently purely commercial / economical interactions. He looks at human beings as emotional chimpanzees – which you may say is exactly what we are – and as shaped by implicit social norms; we are not as logical as we’d like to think we are. Seth explains behavior through micro anthropological narrations, which take little time, and stimulate reflecting on the bases of motivation – hence on marketing.
- His posts are filled with anthropological observations: he manages to link to the readers’ emotions. He has a talent for finding latent emotional roots in apparently purely commercial / economical interactions. He looks at human beings as emotional chimpanzees – which you may say is exactly what we are – and as shaped by implicit social norms; we are not as logical as we’d like to think we are. Seth explains behavior through micro anthropological narrations, which take little time, and stimulate reflecting on the bases of motivation – hence on marketing.
- The communication strategy which we are trying to refine here is focused on narration, as this is a way to transmit contents . A different strategy is to use design , but then it will be much harder to communicate a specific content; you will need a different design for every post, and find / invent a graphical metaphor. This is what indeed some talented designers are doing: see http://line25.com/articles/tips-for-designing-unique-and-attractive-blog-posts http://www.smashingmagazine.com/the-death-of-the-blog-post/ These are incredible designers that create a different design for each blog post . But as said above, our idea is to excite the reader with narration, not with novel design, as we want the reader to focus on contents . So pick a simple, highly readable, consistent layout for your blog and stick to it. Use very simple typographical tricks to lighten the reading experience, and few pictures. For an example, consider Joel’s clean style. Don’t invent a layout – its non trivial!
- The words that you are choosing there are important too: these should be inspired by the words used by your potential visitors / customers to describe their wishes, hopes, desires, dissatisfactions, fears, worries in relation to your topic / product. You should probably dedicate almost half of the total time you dedicate to the post’ writing to experimenting with the title and start. For example, in the case of our Patapage site it took me months to get to a decent pitch. A blog post title is somehow less important than a home page pitch, but still put a significant part of your effort on the opening.
- Why telling stories is good idea? First you should realize that “by default”, nobody is interested in your blog posts, apart from very few people close to you who maybe, maybe, are interested. This is so important to deserve repetition and bold fonts: nobody is “spontaneously” interested in what you are writing. This is a “negative” truth. But here comes a “positive” one: people are hungry for stories. These two facts can help all along your writing.
- As a technician, you are probably the least apt to communicate to the general public, and you also have to communicate the hardest topics. Furthermore, what you are trying to say cannot be trivialized without losing its essence. If you explain your ideas in technical terms, it will be non trivial to keep the attention of the readers. This is why using stories is a good idea: you can begin communicating non trivial ideas building up the readers’ attention. So tell a story. Now, not a silly story : the point is not telling jokes, the point is to introduce your topic . The conclusion is: in your post, tell stories, about conflicts, experiences, problems leading to your theme, and you’ll get the reader’s attention.
- If you are working with a large budget, the simplest way to solve any copywriting problem like writing good blog posts is simply to hire a copy. With the web and social media opening “windows” on companies’ activities, many (most?) companies actually need to create well written, interesting contents every day of work. Now, can you hire a full-time copy? If you can’t, like me, you can do a lot by yourself. As a startup, there are several occasions where we got perfectly good solutions with a little internal research instead of paying expensive consultants with dubious competencies. The “solution” hire a consultant simply assumes that consultants are competent by default, which is often not the case. Need to write a license? Need a user guide? Need SEO optimization? Hire an expert. We didn’t, and are happy with the results; again, these problems appear continuously, so you need the relative competencies in-house. In order to write, you need to have some “creative spirit”. It is impossible to learn to be creative: Steve Jobs as quoted in Inside Steve’s Brain says that seeing people trying to become creative is “painful to watch”. Indeed it is. Here I’m just assuming that you are, and that maybe your attention needs to stop a bit on your own writing style.