PDA

View Full Version : How can I programming without documentaion



EftekasatMasreya
May 14th, 2010, 09:34 PM
There are some problems in open source
when I want to programing some of open source like add some feature or so on
I faced a big problem ... There isn't documentation about this source???
I Depended on reverse engineering but some times there are some code I can't understand it
I'm Just open this thread to know .. Are there documentation for all open sources or what?

lisati
May 14th, 2010, 09:41 PM
Having good documentation about how a program works sure can help, particularly when you want do modify or adapt something that someone else has written.

When I was working full time as a programmer many years ago, the companies I worked for encouraged their staff to document things properly. Unfortunately, with software we obtain through the internet, we aren't always afforded that luxury. This leaves us with having to rely on experience, general know-how, and the ability to research how things work.

doas777
May 14th, 2010, 09:44 PM
each project should provide it's own documentation. if it does not, ask the dev team. if they ahve some they will likely pass it on.

StephenF
May 14th, 2010, 09:49 PM
Is everything fully documented? No. Keeping large amounts of documentation on a fluid codebase requires considerable effort for it to remain in sync.

Whenever documentation is found it will almost certainly be in English though there are automated translation tools available.

HotCupOfJava
May 15th, 2010, 05:10 AM
Yeah, it would be nice to have documentation, but that will frequently NOT be the case. Part of being a programmer is having to sometimes solve the puzzle of what a particular piece of code is trying to accomplish.

mmix
May 15th, 2010, 06:40 AM
http://en.wikipedia.org/wiki/Software_documentation

http://en.wikipedia.org/wiki/Literate_programming

nvteighen
May 15th, 2010, 11:41 AM
Just something... Sometimes, when a code base is still very immature, it's more worth not to have documentation because it'd add the cost of mantaining something doomed to be change sooner or later. From my observation, I see that the only documentation available in early stages are code comments and very stubby function-interface descriptions... never full-fledged API documentation.

(&*4h*)#$
May 16th, 2010, 06:24 AM
In my experience in coding in open source projects (in which we don't follow some rules of software engineering), one of the projects that I handled did not have a separate documentation for what is within the code. Rather, most of the time it is found among the comments in the code, to help you trace what is going on.

Of course, personally, I would prefer having separate documentation describing the structure of the program, but as what some have already mentioned, the development pace might be too fast in order to provide a completely accurate explanation of the structure. Unless, of course, it has reached a stage when overhauls are not very common. (That is, when the project has gone large enough.)

That is when code reading skills might come in handy. Although I do not find that particularly helpful when the project has become extremely large already. (And the structure of their components are not quite clear.)