Documenting A Critical Code Base @ Axians
I’m on assignment this week at Axians, a subsidiary of the large French conglomerate Vinci, that is specialized in providing custom audiovisual installations to corporate and institutional accounts. The objective of my work is to secure a code base that is critical to continued operations at a high-level institutionnal account. I have introduced Bazaar and getting the code base under change control. I have also introduced Doxygen as a source code documentation tool (it is a C++/C codebase). Things are working out well and my contact appreciates the possibilities of these tools. More as the assignment moves forward on this post…
Any other good tools, methodologies or suggestions for documenting a critical codebase ?
Update : Nothing special to report ! The assignment went well and will finish off tomorrow with a big deck of slides that explain tool setup, tool usage, application architecture, application run-time configuration, and some ideas for starting a future software development project in a controlled environment with unit testing, continuous integration, etc…
One of the time consuming aspects of the assignment was simply setting up the toolset (Bazaar and Doxygen) in a Windows XP development environment. There are a lot of pieces here and there that are useful to someone that can benefit from tools like TortoiseBzr and simply getting them together and documenting there installation idyosyncranies is some work. It would be great if a comprehensive Windows installer for these tools existed, then again my customer got very interested in Ubuntu watching me work over my shoulder, so maybe they will start to leave Windows behind little by little !
Discussion Area - Leave a Comment