Doc Dep: A tool to handle the dependency of code and its corresponding documentation

01 Nov 2010 ideas

As I work on Abu, I realize that documenting a project is a separate side project in and of itself. I started with a simple Idea.txt, and that has burgeoned into the following:

And what’s interesting is the interplay between changes I make to the code (or design) and these documents. Each change in code/design obviously impacts one or more of these documents, but there’s no easy way for me to keep track. Eg, change in design impacts the user and developer guides, the news file, and sometimes the readme and roadmap files. Any new top level directory added  changes the contents file and so forth.

Now, what if I had a way to say “this code file impacts these document files”, so that when the code file changes, I have to change the corresponding document? That then, is the idea - DocDep - which will have:

© 2024 Vinod KD