I am getting ready to launch a tech/personal opinion blog slightly more geared towards technical details. What documentation style is best for a journalistic/technical doc style? Thanks.
10
-
5Talk like your audience. Write like the tech bloggers you read and admire. Adopt any style you like and can get away with and can be comfortable maintaining in public for the rest of your life if you're successful. The simplest solution is to write like you talk, just because it's easier to remember. Just be sure you can talk well.– John LawlerJan 8, 2013 at 14:37
-
1What Prof. Lawler said.– RobustoJan 8, 2013 at 14:55
-
Do you have any particular styles in mind to choose from?– MitchJan 8, 2013 at 15:51
-
Thanks for all the comments. I get the writing voice part - but I think I was curious in terms of MLA, Chicago or other documentation style when citing sources and such - what's the best format to mimic for a pseduo journalistic site? Chicago?– motleydevJan 9, 2013 at 6:40
-
@motleydev, this is not a suitable question, because the answer is: whatever you like. There are no rules how to mark citations. You have to mark them and list the source. You can use Chicago, MLA or your own style. It's your blog. Every newspaper/magazine/whatever out there makes its own decisions also.– John SmithersJan 9, 2013 at 10:03
|
Show 5 more comments
1 Answer
I always use a simple rule: your style should reflect your intentions. If I was writing a novel, and wanted to describe a room in exquisite detail, I would use a lot more adjectives than if I were writing some code documentation.
Basically, I'd say follow Strunk & White's The Elements of Style and keep your language as straightforward as possible. Since this is a technical blog especially, active voice and "making every word tell" will go a long way.
