Forum #15 - Topic #48 - Message List
Hi, Anton-san, I'm Yamamoto at Orkney. It's first time to comment something :)
From October, another Japanese member will join us and (maybe) going to develop pgRouting demo. She was studying routing theory, but not so familiar with pgRouting itself as Matthieu is.
So, I think we need documentation for her (or future commiters following.) Currently I'm feeling that existing documentation is not focused on pgRouting beginners, so I want to prepare the base (this is what I felt when I maintained pgRouting application last year)
I'm thinking the first task is to find the former API documentation and update it to current code. And, I want to know what kind of "Document" is there (including source comment, of course). If we found new kind of docs are needed, I'm thinking It's a way to assign the new member for the documentational tasks.
Please let me know the current status, and tell me how I can help you in this point.
-
Message #176
Yamamoto-san,
Thanks for your comment! Maybe we have to make it easier to find the documentation, but it is already there (pgRoutingDocs). Not many things changed to the previous version. The quality could be better, that's right.
The "API" documentation we removed (it was more a function description, API was the wrong term), because it didn't have any practical value in my and Anton's opinion. Normally users want to know about the wrapper functions but don't want to change the algorithm itself.
pgRouting is not supposed to be for beginners, I think. We can discuss the need of a beginner tutorial if you like.
The next task after FOSS4G is working on the documentation, because there have been several changes and improvements and the current version has not good quality. The best way to learn about pgRouting is writing tutorials and documentation, so this will be done by the new team members. As far as I understood, this was also your idea.
daniel09/20/07 14:52:43
