Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Formatting blog posts like the pros

+0
−0

I am new to writing. I have seen Jeff Atwood's blog and I am really impressed how he writes. I have seen a similar manner on wordpress docs too. I am still confused with some issues while writing. Here they are,

  1. I understand that important point should be made bold but I find that there are many important points that should be made bold.
  2. What content should be blockquoted?
  3. When to use code sample except code snippets?

Please help me out. Thanks

History
Why does this post require moderator attention?
You might want to add some details to your flag.
Why should this post be closed?

This post was sourced from https://writers.stackexchange.com/q/3195. It is licensed under CC BY-SA 3.0.

0 comment threads

2 answers

+1
−0

On bolding: Assume that on a casual browse, the reader's eye will always leap first to headers, and to words in bold. They'll help him understand the structure of your piece, and the most important bits. Here's a simple example - the bolded opening lines give structure, and a few key concepts are bolded to stand out immediately.

Drinking MegaPop is bad for your health. Its ingredients include cyanide, pesticide, cidercide and patricide.

Drinking MegaPop is bad for the environment. Every year, thousands of adorable bunnies are killed by MegaPop executives, and used as fuel for their ozone-depletion devices. Scientists with exceptionally big foreheads contend that merely by placing a blanket ban on all production of MegaPop, they expect that garbage production in the United States would drop by 170% and every citizen would get a free Smokey the Bear lapel pin.

Drinking MegaPop is bad for international politics. The League of Foreigners Who Don't Like Us have cited the bitter breath caused by MegaPop as their #1 reason for disliking us. MegaPop has been shown to cause leaders to make irrational, unwise decisions (such as consuming more MegaPop). Remember: a nation that drinks MegaPop is a nation that cannot be trusted. Don't let us be that nation.

On blockquotes: Blockquotes are generally used for presenting quotes from other work; a quote that's more than a line or two should be blockquoted because that clearly differentiates it from the main flow of the text, from your blog post addressing the reader.

Blockquotes are similarly appropriate for other snippets that disrupt the main flow of your writing. The example I gave above for bolding is blockquoted; that makes it very clear that that section is different from the rest of the text. It makes it very clear where the example begins and where it ends. So: examples, long asides, imaginary scenes ("Oh, yeah! I could totally imagine Agent Scully meeting Captain Picard! It'd probably go something like this:...") and other such diversions can be blockquoted, particularly if they make the structure more clear.

On code snippets: only for code, or examples of computer input/output, copy-pasting from a shell command line, etc.. It's basically a blockquote formatted specially for code (which would, as per above explanation, be a disruption of the main, prose-written flow of the post).

History
Why does this post require moderator attention?
You might want to add some details to your flag.

0 comment threads

+0
−0
  1. If you have that many important points, make them a bulleted list instead of making them bold. They will stand out without being overwhelming.
  2. Blockquote is used to quote a big block of text, as opposed to quoting one or two sentences.
  3. You don't.
History
Why does this post require moderator attention?
You might want to add some details to your flag.

0 comment threads

Sign up to answer this question »