Poser
-
5. write serie of articles ? David Never forget: "Stay kul and happy" (I.A.)
David's thoughts / dnhsoftware.org / MyHTMLTidydnh wrote: 5. write serie of articles ? Not really an option as it's a single stand alone game that is already based on previous work published here. In fact I've just counted and the complete beginner would probably be recommended to read about half of the articles I've previously published. It doesn't have neural networks in it. pseudonym67 My Articles[^] "They say there are strangers who threaten us, In our immigrants and infidels. They say there is strangeness too dangerous In our theaters and bookstore shelves. That those who know what's best for us Must rise and save us from ourselves." Rush
-
dnh wrote: 5. write serie of articles ? Not really an option as it's a single stand alone game that is already based on previous work published here. In fact I've just counted and the complete beginner would probably be recommended to read about half of the articles I've previously published. It doesn't have neural networks in it. pseudonym67 My Articles[^] "They say there are strangers who threaten us, In our immigrants and infidels. They say there is strangeness too dangerous In our theaters and bookstore shelves. That those who know what's best for us Must rise and save us from ourselves." Rush
pseudonym67 wrote: it's a single stand alone game that is already based on previous work published here There you go, just pick out the parts that are unique and interesting about the new code and write the article about those. Provide a link to the previous articles for anything major that's based on older code. If it's worthy of an article you shouldn't have much trouble picking out some parts that are new and worth writing about. -- Eric Move along, nothing to see here.
-
O.K. Here's the rub. My latest project is pretty much finished and will probably be published to this site in the next week or so and I've hot a minor problem and thought I'd test the water on this one to see what the response will be. The problem is that I've arrived at the part of the article where I have to write the decsription of the code and what with this being a programming site it is kind of important to get it right. The problem is that the core part of the code is about 6000 lines long and it's a bit complicated in fact I wouldn't be surprised if a comprehensive description of the code didn't take twice as many lines as the code does. So that options seem to be 1, write a very very large article and explain everything in detail which means it probably wont get published until the autumn. 2, skim over it and hope for the best. 3, provide some sort of diagramatic description 4, Be an a*( and tell people to just read it. Ideas, suggestions !!! pseudonym67 My Articles[^] "They say there are strangers who threaten us, In our immigrants and infidels. They say there is strangeness too dangerous In our theaters and bookstore shelves. That those who know what's best for us Must rise and save us from ourselves." Rush
-
i there's the rub for in the sleep of death what dreams my come when we have shuffled off this mortal coil for who bear the whips and scorns of time the oppressors wrongs the proud man's contumely i don't remember the rest... /\ |_ E X E GG
:laugh: I didn't remember that much. pseudonym67 My Articles[^] "They say there are strangers who threaten us, In our immigrants and infidels. They say there is strangeness too dangerous In our theaters and bookstore shelves. That those who know what's best for us Must rise and save us from ourselves." Rush
-
O.K. Here's the rub. My latest project is pretty much finished and will probably be published to this site in the next week or so and I've hot a minor problem and thought I'd test the water on this one to see what the response will be. The problem is that I've arrived at the part of the article where I have to write the decsription of the code and what with this being a programming site it is kind of important to get it right. The problem is that the core part of the code is about 6000 lines long and it's a bit complicated in fact I wouldn't be surprised if a comprehensive description of the code didn't take twice as many lines as the code does. So that options seem to be 1, write a very very large article and explain everything in detail which means it probably wont get published until the autumn. 2, skim over it and hope for the best. 3, provide some sort of diagramatic description 4, Be an a*( and tell people to just read it. Ideas, suggestions !!! pseudonym67 My Articles[^] "They say there are strangers who threaten us, In our immigrants and infidels. They say there is strangeness too dangerous In our theaters and bookstore shelves. That those who know what's best for us Must rise and save us from ourselves." Rush
An article should not just be the code translated into english. In my articles I try to imagine that I am explaining the code to a fellow programmer. When you do this, you do not explain each line. Instead, you say, OK, this section deals with this, and this function does this and returns this. The flow of code, and the critical data structures, are more important than a line-by-line description. And to sum up, a How To Use section will help people get started using your code.
-
O.K. Here's the rub. My latest project is pretty much finished and will probably be published to this site in the next week or so and I've hot a minor problem and thought I'd test the water on this one to see what the response will be. The problem is that I've arrived at the part of the article where I have to write the decsription of the code and what with this being a programming site it is kind of important to get it right. The problem is that the core part of the code is about 6000 lines long and it's a bit complicated in fact I wouldn't be surprised if a comprehensive description of the code didn't take twice as many lines as the code does. So that options seem to be 1, write a very very large article and explain everything in detail which means it probably wont get published until the autumn. 2, skim over it and hope for the best. 3, provide some sort of diagramatic description 4, Be an a*( and tell people to just read it. Ideas, suggestions !!! pseudonym67 My Articles[^] "They say there are strangers who threaten us, In our immigrants and infidels. They say there is strangeness too dangerous In our theaters and bookstore shelves. That those who know what's best for us Must rise and save us from ourselves." Rush
Go through the code, and explain the bits that are 1) non-trivial, and 2) not already well explained in other articles (perhaps linking to the articles that explain what you don't). If it takes 20 pages to do that, then so be it (but provide a good index).
You must be careful in the forest Broken glass and rusty nails If you're to bring back something for us I have bullets for sale...
-
O.K. Here's the rub. My latest project is pretty much finished and will probably be published to this site in the next week or so and I've hot a minor problem and thought I'd test the water on this one to see what the response will be. The problem is that I've arrived at the part of the article where I have to write the decsription of the code and what with this being a programming site it is kind of important to get it right. The problem is that the core part of the code is about 6000 lines long and it's a bit complicated in fact I wouldn't be surprised if a comprehensive description of the code didn't take twice as many lines as the code does. So that options seem to be 1, write a very very large article and explain everything in detail which means it probably wont get published until the autumn. 2, skim over it and hope for the best. 3, provide some sort of diagramatic description 4, Be an a*( and tell people to just read it. Ideas, suggestions !!! pseudonym67 My Articles[^] "They say there are strangers who threaten us, In our immigrants and infidels. They say there is strangeness too dangerous In our theaters and bookstore shelves. That those who know what's best for us Must rise and save us from ourselves." Rush
Go for a diagram, or maybe a couple. Class structure, general flow, and interaction between classes are a couple suggestions. That way, when someone is interested in looking at the code, they have some nice diagrams that help them get familiar with the overall concepts. Marc MyXaml Advanced Unit Testing YAPO
-
i there's the rub for in the sleep of death what dreams my come when we have shuffled off this mortal coil for who bear the whips and scorns of time the oppressors wrongs the proud man's contumely i don't remember the rest... /\ |_ E X E GG
eggie5 wrote: i there's the rub "I"? Shouldn't that be "Aye"? :-D Or are you referring to yourself? ;P
My: Blog | Photos | Next SQL Presentation WDevs.com - Open Source Code Hosting, Blogs, FTP, Mail and More
-
eggie5 wrote: i there's the rub "I"? Shouldn't that be "Aye"? :-D Or are you referring to yourself? ;P
My: Blog | Photos | Next SQL Presentation WDevs.com - Open Source Code Hosting, Blogs, FTP, Mail and More
-
O.K. Here's the rub. My latest project is pretty much finished and will probably be published to this site in the next week or so and I've hot a minor problem and thought I'd test the water on this one to see what the response will be. The problem is that I've arrived at the part of the article where I have to write the decsription of the code and what with this being a programming site it is kind of important to get it right. The problem is that the core part of the code is about 6000 lines long and it's a bit complicated in fact I wouldn't be surprised if a comprehensive description of the code didn't take twice as many lines as the code does. So that options seem to be 1, write a very very large article and explain everything in detail which means it probably wont get published until the autumn. 2, skim over it and hope for the best. 3, provide some sort of diagramatic description 4, Be an a*( and tell people to just read it. Ideas, suggestions !!! pseudonym67 My Articles[^] "They say there are strangers who threaten us, In our immigrants and infidels. They say there is strangeness too dangerous In our theaters and bookstore shelves. That those who know what's best for us Must rise and save us from ourselves." Rush
I guess it depends on the project. If it compiles to a ready-to-use exe, all we are interested is the nifty cool and clever "nonstandard" things. If it's a reusable library/control/DLL, most important are overall structure, design decisions, "rules" you set for yourself etc. that help understanding what it does, and what to expect. (described verbally with aid of diagrams) Finally, if it shows something neat that needs to be picked apart, adjusted, and extended, write a vert very large (series) of articles.
Pandoras Gift #44: Hope. The one that keeps you on suffering.
aber.. "Wie gesagt, der Scheiss is' Therapie"
boost your code || Fold With Us! || sighist | doxygen -
An article should not just be the code translated into english. In my articles I try to imagine that I am explaining the code to a fellow programmer. When you do this, you do not explain each line. Instead, you say, OK, this section deals with this, and this function does this and returns this. The flow of code, and the critical data structures, are more important than a line-by-line description. And to sum up, a How To Use section will help people get started using your code.
Who voted this a one?? I would think it deserves a 5. :omg: -- LuisR
Luis Alonso Ramos Intelectix - Chihuahua, Mexico Not much here: My CP Blog!