Project Documentation – Self Audit
So a late night. I spent a lot of time at work today with our MicroStrategy project documenting all of the various elements, and I have some things that I do that might be unique, and others that might not, but it got me thinking about the “proper” way to document a project.
One of the things that I don’t like about the MicroStrategy tutorial project is the sporadic documentation. Some metrics are documented, some reports…and no filters, but that aside, here’s what I have recently started doing with my project at the “job” job (my real job).
First, find your metric or filter or whatever and right click, and select properties.
So, you’ll see that there’s the description section where you can say something along the lines of “This is a metric that measures the Gross Margin blah blah”. But there’s also a seldom used “Long Description”. So the question is…why would you use this “Long Description”? I use it for self auditing! As any consumer of BI software is aware, one of the most common questions you’ll hear is – are you sure this is right? Unless you’re maintaining the source database, data warehouse, and etl…the answer is – “well…no”. But, you can at least make notes for yourself because no one remembers everything.
The point is…documentation is more than just helping the user understand what it is they’re dragging and dropping into their grids, it’s also there to help you understand what it is you’ve beein doing with the project, and keep track of when you’ve validated the data. Now when your users come up to you and ask whether or not it’s correct, you have at least a time that is was validated, and who did the validation. Consider it a CYA if you’re that type (international readers…google it). The Change Journal can help that a bit, but it’s a little bit of a space and processing drain, and realistically, every time you make a change…do you really want to document? Simmer down engineers. I suppose you can turn MicroStrategy into a subversion repository, but life should have a little mystery right? With the Change Journal, you’re also only documenting changes to whatever you’re editing…not necessarily things about that element.







Recent Comments