DEV Community

Cover image for Content Structure: The Do's and Dont's of Content Creation

Content Structure: The Do's and Dont's of Content Creation

Maxi Contieri on November 24, 2022

Many tips and tricks on how to make amazing content. TL;DR: Follow these experience tips to improve your technical articles. Backgroun...
Collapse
 
katafrakt profile image
Paweł Świątkowski

I wonder why you listed plagiarism detectors under useful tools. If I write myself then I actually know for a fact that it's not a plagiarism ;) Could you elaborate on this one?

Collapse
 
cicirello profile image
Vincent A. Cicirello • Edited

@katafrakt: I imagine that @mcsee might have other reasons in mind for this as well, but as an educator that sometimes requires students to use a plagiarism detector before submitting assignments, I can say that I do so because those tools aren't just about detecting plagiarism. The better ones also make automated suggestions on writing quality issues including some of Maxi's recommendations like using active voice rather than passive.

Collapse
 
mcsee profile image
Maxi Contieri

In my articles I usually add quotes (citing the author) and sometimes examples borrowed with permission (and a direct link to them).

Nevertheless I use short paragraphs and using plagarism tools helps me find similar articles.
Let's do an exercise: Write yourself a brand new short article. Then use any plagiarism tool. You will be surprised ,

It is yet another tool. It does not mean you are stealing from other people.

Thread Thread
 
jankapunkt profile image
Jan Küster 🔥

This is also common practice in science when publishing articles. The more publications to a certain topic the easier the chance to unintentionally plagiarize.

Thread Thread
 
mcsee profile image
Maxi Contieri

Exactly!

I have a master in Computer Science. Searching for previous work is mandatory.

Thread Thread
 
katafrakt profile image
Paweł Świątkowski

Did the exercise. Put one of my existing shorter articles into a plagiarism tool. It found a similarity with the article itself on my blog (because it's already published) and nothing else. Unfortunately I fail to see the surprise and usefulness of this.

Collapse
 
cicirello profile image
Vincent A. Cicirello

Very nice post with great suggestions. I like your use of a template in your "code smells" series. Whenever I'm reading one of those, I like knowing how it is structured and exactly where to scroll for specific types of information. Your "code smells" template reminds be a bit of the structure of a pattern from the GoF's Design Patterns book. Obviously it is a different template, but same basic idea of organization.

Collapse
 
mcsee profile image
Maxi Contieri

Yes. GOF's book amazing because of the structure and naming.

Many patters are outdated or anti-patterns now. But the structure and common terminology was ground breaking

Collapse
 
sangamswadik profile image
Sangam SwadiK

Good tips!
I think, having a well defined structure/template to your blog gives new readers more control on the sections they want to focus, and ignore the rest. At the same time existing readers know what to expect as they are already familiar.

Collapse
 
yukikimoto profile image
Yuki Kimoto

Thanks.

Collapse
 
vishwastyagi profile image
Vishwas Tyagi

Great tips. I will try to follow them. Thank you for sharing.

Collapse
 
yuridevat profile image
Julia 👩🏻‍💻 GDE

👏👏👏 so many useful tips in one post!

Collapse
 
balastrong profile image
Leonardo Montini

Thank you Maxi, great advice as usual!

A few more words on avoiding drafts... you're right, sometimes I write a draft, just a few lines, and I leave it there.
When I come back after some hours/days I feel lost and I forgot the Idea I had in mind.
It would have been much better to keep the momentum while writing the short draft and expanding it immediately!

Collapse
 
mcsee profile image
Maxi Contieri

indeed!

Took me years to learn.
I had to discard about 100 "ideas" and start from scratch