Yves,
I don't know if this will help, but I've been working since Devcon on a routine that builds a set of HTML pages describing a project or projects. As a proof-of-concept I've concentrated on VCX's, and have it doing pretty much what I want, which is to rapidly (less than 3 minutes) build a cross-referenced set of pages detailing my project. Hopefully this week I will be adding what I've been itching to add since Devcon: logic to pull out HTML comments I've been embedding in code, ending forever the frustration of keeping docs up-to-date with code.
If you'd like to see the current prototype I'd be happy to e-mail it. I will be improving it over the next few weeks and intend to use it as my sole documentation tool.
You can also check out West Wind's HTML help builder. I liked it for awhile, but it turned out not to solve my problem of keeping docs and programs in sync, I still had to do lots of retyping of comments and explanations.
>I know I can put up data flows, processflows, class docs using UML etc...
>
>But I don't really know where or how to start or which guidelines to follow.
>Which sections should there be in a tech doc, or how to describe the items.
>
>Any guidance on this would be highly appreciated.
>Bookreferences, URL's, experiences.....
>
>Thanks in advance.
Précédent
Suivant
Répondre
Voir le fil de ce thread
Voir le fil de ce thread à partir de ce message seulement
Voir tous les messages de ce thread
Voir tous les messages de ce thread à partir de ce message seulement