一般来说,一篇文章的目标 [英] Goal of an article, in general

查看:103
本文介绍了一般来说,一篇文章的目标的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

您好



我的上篇文章似乎被拒绝的理由让我想起了CodeProject上一般文章的目标



评论是:

不是一篇文章:如果你带走了代码块,那里真的没有剩余吗?



(..)我认为如果你解释'你如何'进行解析,这将是一篇更好的文章 - 令牌,正则表达式,dsl等

有时它不是关于目的地,但旅程




看来这些人认为一篇文章不应该是一种解决方案:对使用过的(特殊)技术的解释。 br />
但是有些代码,比如我的Zip中的代码,不涉及特殊技术而且不需要解释,它们只是使用简单和普通的编程技术解决问题的简单方法。



文章常见问题说我们需要一些文件并列举我的文章适合的点。



明确地说,我的反思是:如果特殊技术及其解释是文章的要求,请将此要求添加到常见问题解答和提交页面中,这是非常重要的一点。



这样可以避免作者浪费时间准备文章,而Zip则因未提出要求而被拒绝。

这是一个明确的问题。



谢谢。

Hello

My last article seems to be refused for reasons that make me think about the goals of articles on CodeProject in general.

Comments are:
. "Not an article: If you take away the code block there isnt really much left is there?"
and
. "(..) I think this would be a much better article if you explained the 'how' you do the parsing - tokens, regex, dsl etc
Sometimes its not about the destination, but the journey
"

It seems these persons suggest an article should be something else than a solution: an explanation of the used (special) techniques.
But some code, like the one in my Zip, do not involve special techniques and don't need explanations, they are just a simple solution to a problem, using simple and ordinary programming techniques.

The article FAQ says "we need some documentation" and enumerates points my article fit.

In clear, my reflection is: If special techniques and their explanation is a requirement for article, please add this requirement to the FAQ and to the submitting page, as a very important point.

That will avoid authors wasting hours preparing an article and a Zip to be refused for unsaid requirements.
It is a matter of being clear.

Thank you.

推荐答案

Quote:

但有些代码,比如我的Zip中的代码,不涉及特殊技术而且不需要解释,它们只是使用简单和普通编程技术解决问题的简单方法。

But some code, like the one in my Zip, do not involve special techniques and don't need explanations, they are just a simple solution to a problem, using simple and ordinary programming techniques.





除了这些评论让我觉得你写了一篇文章应该归类为提示/技巧而不是文章。



文章采取一些主题并对其进行扩展,展示解决问题的方法,或引入新技术。文章应该关注如何完成问题或主题的各个部分,而不仅仅是代码转储和简要说明它的作用。



程序员阅读文章是因为他们试图解决问题。文章很少解决这个问题,但有些文章可能适合。你解释的部分越多,读者就越能看出它们如何适应他们试图解决的问题。在提交文章时,请记住,您的文章的最终目标通常与您的读者不一致,但您的读者可能对您如何解决问题而不是最终产品更感兴趣。



Along with the comments makes me think that you wrote an article that should be classified as a Tip/Trick instead of an article.

Articles take some topic and expand on them, show a way of solving a problem, or introduce a new technique. Articles should focus greatly on how to accomplish the pieces of the problem or topic, not just a code dump and short explanation of what it does.

Programmers read articles because they are trying to solve a problem. Very rarely does an article solve that problem but some of the pieces may fit. The more pieces you have explained, the better the reader can see how they fit into the problem that they are trying to solve. In submitting an article try to remember that the ultimate goal of your article is typically not in line with your reader, but your reader may be more interested in how you solved the issues rather than the final product.


Ron,谢谢你的争论答案。



我对提示/技巧类别的理解是它是一个解释几个代码行的好地方技术。

最新文章是一个很好的例子:两个7行示例,一个解释该技术的好文本,没有Zip档案。



我同意文章一词表明它将会解释一种技术。

但是,如果你想发布一个不是简单技巧的解决方案,也不是技术解释怎么办?



让我们想象一下有人想为一个常见问题发布一个相当大的解决方案,但这个解决方案不涉及任何p关键技术在其代码中?

我不认为作者将其作为一种技巧发布。

作为一篇文章,它将更专注于其程序的使用而不是任何技术。



到目前为止,我认为CodeProject是一个用一些文档发布一些有用的代码的好地方(如官方网站的文档所述,方式),比GitHub的纯源代码商店网站更多的文档或解释,但我现在明白这些文章有一些没有说的要求。



我不知道CodeProject中是否应该有第三种方式,作为解决方案,但现在我很清楚现有的文章和提示类别并不适合所有用法。
Ron, thank you for your argumented answer.

My understanding of the Tip/Tricks category is it is a good place to explain a few-code-lines technique.
A recent article is a good example: two 7-lines examples, a good text that explains the technique, and no Zip archive.

I agree that the word 'article' suggests it will explain a technique.
But what if you want to publish a solution that is not a simple trick nor a technique explanation ?

Let's imagine somebody wants to publish a rather big solution to a common problem, but this solution does not involve any particular technique in its code ?
I do not imagine the author publishing it as a trick.
As an article, it would be more focused on usage of its program than on any technique.

Until now, I thought CodeProject was a good place to publish some useful piece of code with some documentation (as said in the official site's documentation, by the way), something more documented or explained than a pure source code store site as GitHub, but I now understand there are some not-said requirements for the articles.

I don't know if there should be a third way in CodeProject, something as 'solutions', but now it seems clear to me the existing 'article' and 'tip' categories do not fit all usages.

这篇关于一般来说,一篇文章的目标的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆