Anti-Patterns in Software Blogging

(refactoringenglish.com)

46 points | by ilreb 3 hours ago

6 comments

  • ram1500natrluvr 17 minutes ago
    "The meandering intro" might be the most common mistake, by far, but the most damaging mistake, by far, is the failure to connect the topic with something the readers are familiar with (anti-pattern #2). Some things simply require a certain level of expertise/prerequisites to begin to understand, but I've repeatedly seen in software blogging, READMEs, etc. a failure to answer "what is this, compared to what I'm familiar with, and if I'm not familiar with anything relevant, why should I want to be?"

    This applies to almost everything in the software space. New tool? New design pattern? New library? Language idiom? Language? Or, for more modern takes, new model? New harness? New harness option? New use pattern? Give a brief summary of what a project looks like without it, to convey the problem that its existence alone is solving. Then go into the details of how it might compare to other solutions.

    Maybe it's just a specific way of how my brain works that finds this sort of information intuitive, and the lack of it particularly annoying.

  • weinzierl 1 hour ago
    "The meandering intro"

    Not only the intro. Many bloggers try to write as if they'd writing a story, building suspense and all. For technical writing, don't bury the lede.

    • pastel8739 40 minutes ago
      Is blogging necessarily technical writing?
  • rglullis 26 minutes ago
    > From the reader’s perspective, there are a billion other articles they could be reading. Why should they read yours?

    I'd rather read something that shows any semblance of personality than yet-another engagement/reach/marketability-optimized "article" that just follows all the established tropes and could be written by any drone or clanker.

  • mobilejdral 30 minutes ago
    The community yearns for a new stack overflow.
    • dewey 6 minutes ago
      It doesn't really, as you can see in their traffic numbers. People are not stopping to use it because they dislike the platform (Most people would not even be aware of any moderation criticism, especially if they are just readers).

      People are not using it any more as any AI assistant will give you the answer in seconds, perfectly adapted to your use case and with an easy way to ask follow up questions.

    • esafak 21 minutes ago
      Do they? How would it be different?
  • mcphage 14 minutes ago
    My biggest pet peeve: "Here's this thing I did once, and now I'll tell everybody how to do it as if I were an expert".
    • dewey 9 minutes ago
      How would you define the limit above which it's appropriate to share your findings on a given topic on your blog?
      • antonyt 1 minute ago
        Not OP, but it's the "as if I were an expert" part that rankles. It's fine to share your experiments and learning projects, but frame them as such. Some writers present their imperfect weekend experiments as if they're doing us a favor by giving out their genius for free.
  • abubnov75 1 hour ago
    Helpful, thank you. I'm just going to write such an article
    • all2 53 minutes ago
      Wait, do you intend to implement each anti pattern into a single article? Or do you intend to write an article with none of these anti patterns?