Documenting MSI

Typical of most developers, the documentation comes after the development.

I want to hand over the MSI development over to someone else but obviuosly not just show them the project file and say "get on with it!"

In your opinion, what would be the best way to document this information?, flowcharts are normally good but with having 50 odd custom actions runnning under various conditions could prove to be a nightmare to write.

Also, apart from the obvious Microsoft office suite are there any CASE tools or alike which could handle this well?



0 Comments   [ + ] Show comments

Answers (4)

Posted by: jmcfadyen 13 years ago
5th Degree Black Belt
I use a standard for creating custom actions.

By prefixing properties, CA's, File / Reg variables you can use code to parse the MSI and extract anything that matches the prefix. This way you can automate the creation of tables containing the customised sections of your app.

I use the MS Office object models to generate doco. (ie Word.application) I can send some sample document templates that show how to setup a document to receive data pushed in from external sources.
Posted by: danr29 13 years ago
Purple Belt

If you could send me those templates as well I would much appreciate it! Thanks in advance.

Posted by: deploy.no 13 years ago
Orange Belt
I'd appreciate it if I could have a look at those templates, John ..

This discussion is interesting as I'm working with developing better docu standards myself at the moment. We use a similar approach but as we don't like MS Word we output the data to a plone site instead :-) This far it seems we got quite a job to do when it comes to cleaning up stuff we did BEFORE setting the standards (I know, thats not the way it should have been, hehe).

One thing worth mentioning is that we are now considering moving from using setacl.exe to setacl.ocx and custom tables, like documented here by a post from nheim. The extra tables kind of makes the ACLs more self-documenting, I feel.

Edit: nheim credited for the link
Posted by: jmcfadyen 13 years ago
5th Degree Black Belt
send me your emails and I will forward the doco. [email=john.mcfadyen@gmail.com]john.mcfadyen@gmail.com[/email]
Rating comments in this legacy AppDeploy message board thread won't reorder them,
so that the conversation will remain readable.
This website uses cookies. By continuing to use this site and/or clicking the "Accept" button you are providing consent Quest Software and its affiliates do NOT sell the Personal Data you provide to us either when you register on our websites or when you do business with us. For more information about our Privacy Policy and our data protection efforts, please visit GDPR-HQ