Mindtraveller Messages: 917 Registered: August 2007 Location: Russia, Moscow rgn.
Experienced Contributor
luzr
Well, the real idea about dividing topics per packages is to provide a documenation on modular basis.
I think this is good idea - making docs modular. I also believe that modular approach is fully appliable to specifics-descending docs I proposed earlier.
So my idea is to integrate these two approaches and I`ll try to propose way of doing it below.
General idea of my approach is that adding new package leads to assembling of package-supplied articles & structure to the existing articles & structure. This operation has trivial algorithm:
for (each_article_of_package)
{
if (article_already_presents)
Append_article_text_to_the_existing_article();
else
Copy_article();
}
Maybe it would also be very interesting approach to mark package-blocks with comments, like
%_XXXXX_START_% ........ %_XXXXX_END_%
So if we uninstall package or upgrade it, TheIDE simply removes or updates corresponding blocks and we have updated docs for our latest version of package!
It is discussable of course, but I just like the idea of making docs true user-friendly. And keeping them user-oriented at any cost, because it is matter of making U++ one of leading frameworks among others.
Members
Pages
Help
Register
Login
Home
