|
Certainly. In a previous comment I suggested altering your article to: Discussing the code, How it works, What you learned, and add a link to the full source code.
As a starting point, here’s an example article from one of our top authors:
http://www.codeproject.com/Articles/225692/Html5-WebWorkers-experiment
His primary goal is to demonstrate “Using HTML5 WebWorkers and a custom jQuery plug-in to create a Flickr image wall.” He treats the reader like a beginner. He defines jQuery, explains what WebWorkers are, then gets into why he wanted to create a jQuery plugin. Each progressive section of the article expands on his topic, thoroughly explains the code, explains the limitations he chose in his scope, discusses how each element to his plug-in works, provides numerous code examples, and most importantly, gives a source code download at the top for the reader should they need it.
Drilling down a bit more specifically:
Discussing the Code / How it Works
In Version 4 of your article you have a discussion of Extension Methods, for example, showing certain extension methods and explaining their role in the whole. This is good stuff.
However, using the HTML5 WebWorkers article as an example, there is a step you can go beyond just to listing methods and explaining what each method does. For example, in the HTML5 WebWorkers article there is a section on Custom jQuery Plug-in. He displays the code for the jQuery plugin, and says, "The jQuery plug-in that I wrote does a pretty simple job. It is applied to a specific element, where the jQuery plug-in would accept an array of search terms. For each of the search terms, a new WebWorker is spawned that will do an AJAX Flickr search for images that match that search term. For each WebWorker spawned, my custom jQuery plug-in will hook up to both the onMessage()/onError events from the newly spawned WebWorker. When the WebWorker completes, the WebWorker calls back into the jQuery plug-in, at which point an image wall is created," which basically summarizes how the plugin works. It gives a larger picture of the code he's working on, so there's more to learn from it.
What You Learned
In Version 4 of your article you mostly explain Methods and Functions and Properties. It's not absolutely essential, but it does colour the difference between an article that is focused on teaching, and an article that mostly seeks to share a tool. Going back to an example in the HTML5 WebWorkers article, there is a section that reads:
"OK, so we have the ability to run threads, but unfortunately, we have no threading objects to ensure the communication of these threads, and ensure that there is thread safe access to shared data structures. Seems quite a big oversight. What it does mean is that your WebWorker and its related message handler within the host must pretty much be self contained and not access any shared data structures. I fell into this trap with the code within this article where I was populating a common array, until I realised that this was probably not that smart, and I then moved the array to be scoped locally to the WebWorker, and then it was all OK."
This is valuable in that people using the article as a learning resource can use this experience themselves. Maybe they have experienced similar things, or thought also along the way to populate a common array. Now they know not to do that.
Thanks,
Sean Ewington
CodeProject
|
|
|
|
|
MSBassSinger wrote: from who knows at CP
MSBassSinger wrote: hide behind an "unattended email box"?
MSBassSinger wrote: Not hiding behind an unattended email box,
MSBassSinger wrote: has been reported by digimanus, Nelek, Rhuros, Afzaal Ahmad Zeeshan, MehreenTahir That is very clear who did it.
Social Media - A platform that makes it easier for the crazies to find each other.
Everyone is born right handed. Only the strongest overcome it.
Fight for left-handed rights and hand equality.
|
|
|
|
|
With no avenue to appeal the censorship.
|
|
|
|
|
MSBassSinger wrote: changing the title, shortening the article, removing the previous code blocks, Maybe you did too much shortening?
Quote: My primary point with this article is to look at a process a developer can use to decide whether to write some general functionality, or to use a library. Of course, the secondary point is that JHelpers is just such a library availabe for use, if desired.
You speak about a library that should help me reducing my development time, but you don't explain anything about your library in the technical point of view.You don't give me anything that makes me want to invest my time in checking your library.
Even the new title:
Quote: Build or Buy - A Simple Explanation and Example
The new version of the "article" is more a marketing text than a technical content.
That's why I reported "unclear / incomplete"
And sorry... I still think the same.
MSBassSinger wrote: Where is the recourse to have bad decisions like this discussed, instead of being arbitrary? We are doing it right now, aren't we?
M.D.V.
If something has a solution... Why do we have to worry about?. If it has no solution... For what reason do we have to worry about?
Help me to understand what I'm saying, and I'll explain it better to you
Rating helpful answers is nice, but saying thanks can be even nicer.
|
|
|
|
|
How is it Marketing text" when nothing is being marketed. Nothing for sale. Nada.
The article clearly explains, and focuses on, a way to apply value engineering to the "build vs buy" decision. Code that allows a deeper look at the use of the NuGet package is in a public GitHub.
A reasonable developer, interested in the topic, would then look at some of the functions provide, and think about how long it would take him or her to write it themselves.
As for the snarky "We are doing it right now, aren't we?", only because I had to dig and go to this forum, instead of a simple link in the anonymous email allowing me to have a discussion with those who complained.
What, specifically, is unclear of incomplete? The article defines its purpose, explains the thought process of the purpose, and then offers a conclusion. It doesn't get more clear than that.
I am willing to address any specific flaws you see, but subjective generalities are no excuse for censorship.
I hope you can provide some specifics.
|
|
|
|
|
MSBassSinger wrote: How is it Marketing text" when nothing is being marketed. Nothing for sale. Nada. Neither any technical content is being discused.
If you had tried to sell something, then not only your article would have gone, but your account too.
On the other hand, you mention your JHelpers in almost every paragraph, in the middle of some text that actually has nothing to do with it and telling the name brings nothing to the text or what is being explained in it. Hence, yes, for me this is marketing.
MSBassSinger wrote: The article clearly explains, and focuses on, a way to apply value engineering to the "build vs buy" decision. More the content of a blog.
MSBassSinger wrote: A reasonable developer, interested in the topic, would then look at some of the functions provide, and think about how long it would take him or her to write it themselves. Yes, but you are publishing in codeproject. Please read: Code Project Article FAQ - article requirements[^]
MSBassSinger wrote: As for the snarky "We are doing it right now, aren't we?", only because I had to dig and go to this forum, instead of a simple link in the anonymous email allowing me to have a discussion with those who complained. It is not an anonymous email, it is an automatic generated email by the server (not the same). And it is informing you about what happened and who did it, so neither it is anonymous.
MSBassSinger wrote: What, specifically, is unclear of incomplete? The article defines its purpose, explains the thought process of the purpose, and then offers a conclusion. It doesn't get more clear than that. And yet you miss the point of "technical" article. Forget the "unclear" and think in "incomplete". You are trying to promote your library, describe your library.
MSBassSinger wrote: I am willing to address any specific flaws you see No, you are not. A CP Editor told you some very valid points. And I am trying to tell you other points, you are refusing to see them and "fighting back".
MSBassSinger wrote: but subjective generalities are no excuse for censorship. The site works for and by the community. It has been like that since the very beginning and I suppose (I can't foresee) that will continue being like that for a while. And a community is full of individuals with subjective opinions. That's why it is always needed several matching opinions before any action.
MSBassSinger wrote: I hope you can provide some specifics. That's what I have been trying to.
M.D.V.
If something has a solution... Why do we have to worry about?. If it has no solution... For what reason do we have to worry about?
Help me to understand what I'm saying, and I'll explain it better to you
Rating helpful answers is nice, but saying thanks can be even nicer.
|
|
|
|
|
|
|
.
"the debugger doesn't tell me anything because this code compiles just fine" - random QA comment
"Facebook is where you tell lies to your friends. Twitter is where you tell the truth to strangers." - chriselst
"I don't drink any more... then again, I don't drink any less." - Mike Mullikins uncle
|
|
|
|
|
|
.
"the debugger doesn't tell me anything because this code compiles just fine" - random QA comment
"Facebook is where you tell lies to your friends. Twitter is where you tell the truth to strangers." - chriselst
"I don't drink any more... then again, I don't drink any less." - Mike Mullikins uncle
|
|
|
|
|
|
|
|
.
"the debugger doesn't tell me anything because this code compiles just fine" - random QA comment
"Facebook is where you tell lies to your friends. Twitter is where you tell the truth to strangers." - chriselst
"I don't drink any more... then again, I don't drink any less." - Mike Mullikins uncle
|
|
|
|
|
|
.
"the debugger doesn't tell me anything because this code compiles just fine" - random QA comment
"Facebook is where you tell lies to your friends. Twitter is where you tell the truth to strangers." - chriselst
"I don't drink any more... then again, I don't drink any less." - Mike Mullikins uncle
|
|
|
|
|
|
|
|
|
.
"the debugger doesn't tell me anything because this code compiles just fine" - random QA comment
"Facebook is where you tell lies to your friends. Twitter is where you tell the truth to strangers." - chriselst
"I don't drink any more... then again, I don't drink any less." - Mike Mullikins uncle
|
|
|
|
|
|
Did you forget to report the user?
I did #2 in the article but #1 in the user
M.D.V.
If something has a solution... Why do we have to worry about?. If it has no solution... For what reason do we have to worry about?
Help me to understand what I'm saying, and I'll explain it better to you
Rating helpful answers is nice, but saying thanks can be even nicer.
|
|
|
|
|
bvgger, ta, on it -> done
|
|
|
|
|