Article on large topic should be splitted or kept in a single page?
-
Hi everybody, in my few spare time I am creating a new article on the subject "multiple precision arithmetic" (MP for short). I wrote about arithmetics sharing code snippets, at the end of the article I will present source code which runs unit tests and most notably collects statistics of different MP implementation. I don't know what length an article should be, I just know the stuff I have is quite long. I'm afraid that a single long page could discourage audience, i could strip some paragraphs but I already removed much in the effort to balance clarity and brevity, I'd rather prefer to write a series of 5 articles. I did not found on guidelines "what when and where" it is considered good practice to split long articles into chapters. There are limitations? Suggestions? Best Andrea
-
Hi everybody, in my few spare time I am creating a new article on the subject "multiple precision arithmetic" (MP for short). I wrote about arithmetics sharing code snippets, at the end of the article I will present source code which runs unit tests and most notably collects statistics of different MP implementation. I don't know what length an article should be, I just know the stuff I have is quite long. I'm afraid that a single long page could discourage audience, i could strip some paragraphs but I already removed much in the effort to balance clarity and brevity, I'd rather prefer to write a series of 5 articles. I did not found on guidelines "what when and where" it is considered good practice to split long articles into chapters. There are limitations? Suggestions? Best Andrea
There are both possibilities: Authors that like to post a big single object Authors that like a lot do series "1 from N" format. As long as the single articles don't get too short, and they finish what they start.... I would have no problem. 5 Articles is something manageable. I don't know what is the content, but a possible arrangement could be: 1 - Why, was, Theory background... 2 - Overview about what is coming with snippets and light explanations, how to use it and so on 3 - most interesting parts with deep explanations part 1 4 - most interesting parts with deep explanations part 2 5 - Explanations about the unit tests and statistics functionality that you mention. Practical use cases, comparisons and conclusions Whole code and example project as a download in all or at least #3, #4 and #5 I personally think it is better if you prepare the work and use the draft functionality to write everything, and then publish with links to each other part in each article at the end, when everything is done. I don't like unfinished things and having to wait to understand the big picture.
-
There are both possibilities: Authors that like to post a big single object Authors that like a lot do series "1 from N" format. As long as the single articles don't get too short, and they finish what they start.... I would have no problem. 5 Articles is something manageable. I don't know what is the content, but a possible arrangement could be: 1 - Why, was, Theory background... 2 - Overview about what is coming with snippets and light explanations, how to use it and so on 3 - most interesting parts with deep explanations part 1 4 - most interesting parts with deep explanations part 2 5 - Explanations about the unit tests and statistics functionality that you mention. Practical use cases, comparisons and conclusions Whole code and example project as a download in all or at least #3, #4 and #5 I personally think it is better if you prepare the work and use the draft functionality to write everything, and then publish with links to each other part in each article at the end, when everything is done. I don't like unfinished things and having to wait to understand the big picture.
Hi, thank you for answering. I will follow your advice to publish all at once when ready then. My goal is show (to who is interested) ideas about how to create their own MP library, being myself just an amateur on this kind of stuff. I think to title the series "Teaching arithmetic to a computer" or maybe "The Big Integer Challenge" and divide the article into parts that could be viewed independently, all the code needed to study and build your own implementation is embedded on article. Part #1 the sum
Sample summary: * define sum, simple sum primitive to build long sum, base 10 * carry properties and implication * from base 10 to any other base (specifically CPU register sized digits) * The Long Sum algorithm, with flow chart * carry propagation, carry detection on higher level languages * listing in C language and x64 assembler with comments * bar chart for above implementation timings * Appendix
Part #2 the subtraction, Part #3 the multiplication Part #4 the division: this will probably be the longest one. Part #5 the arithmetic challenge: (did not start writing yet) * show how to use the toy framework i created in order to validate other implementation and compare performance to the reference implementation * evidence parts that need to be changed if porting the code outside of windows environment or different hardware platforms. * install Microsft assembler extension on Visual Studio * show how to create basic statistic from csv dataset generated by the program, * (maybe) challenge the community members to fork and create new fastest implementation In total the document should be like 50 printed pages if on WORD, kind of 8-12 pages per article. Could that be ok? Which is a good measure of an article lenght expressed as "printed page"? What about the source code, should I add it just once to the latest article? Because all the relevant sources are in a single project. Best Andrea
-
Hi, thank you for answering. I will follow your advice to publish all at once when ready then. My goal is show (to who is interested) ideas about how to create their own MP library, being myself just an amateur on this kind of stuff. I think to title the series "Teaching arithmetic to a computer" or maybe "The Big Integer Challenge" and divide the article into parts that could be viewed independently, all the code needed to study and build your own implementation is embedded on article. Part #1 the sum
Sample summary: * define sum, simple sum primitive to build long sum, base 10 * carry properties and implication * from base 10 to any other base (specifically CPU register sized digits) * The Long Sum algorithm, with flow chart * carry propagation, carry detection on higher level languages * listing in C language and x64 assembler with comments * bar chart for above implementation timings * Appendix
Part #2 the subtraction, Part #3 the multiplication Part #4 the division: this will probably be the longest one. Part #5 the arithmetic challenge: (did not start writing yet) * show how to use the toy framework i created in order to validate other implementation and compare performance to the reference implementation * evidence parts that need to be changed if porting the code outside of windows environment or different hardware platforms. * install Microsft assembler extension on Visual Studio * show how to create basic statistic from csv dataset generated by the program, * (maybe) challenge the community members to fork and create new fastest implementation In total the document should be like 50 printed pages if on WORD, kind of 8-12 pages per article. Could that be ok? Which is a good measure of an article lenght expressed as "printed page"? What about the source code, should I add it just once to the latest article? Because all the relevant sources are in a single project. Best Andrea
I am not a big writer myself, so I can only give my opinion. As far as I know, there is no real "regulation", there are only minimum requirements. Not sure if you alredy have done it, but I recommend you to have a look into: https://www.codeproject.com/KB/FAQs/[^] you will find some help about the site, how to publish and what tools you have to do it. I.e.: Code Project Article FAQ[^] Code Project Tags FAQ[^] (just in case... CodeProject Plagiarism FAQ[^]) or the author resources (https://www.codeproject.com/KB/mentor/[^]). I.e: Using the Article Editor (without losing your hair in handfuls)[^] Article Formatting tips for CodeProject[^] Formatting code in Tips and Tricks[^] Markdown[^]
asimonassi wrote:
I think to title the series "Teaching arithmetic to a computer"