4 ms·
I once used Drupal 7[1] at a previous company. It worked out well. Its OSS so cost was my time, time which I would still have spent on a proprietary solution. D
by mmsimanga 9y ago
I once used Drupal 7[1] at a previous company. It worked out well. Its OSS so cost was my time, time which I would still have spent on a proprietary solution. Drupal has a concept of nodes, a node is a type of content. In our case, we were documenting a BI system. I created a node for reports, which were related to database table nodes and in turn had field nodes. It's amazing how much documentation can be associated with a single field. This included historical information why some values differed, the different apps writing to the field and sometimes legislation documents were attached to the field. I used the Feeds[2] module for automated data feeds. I had a script that exported Information Schema from our DWH. I would then import new fields that had been created. We would then edit the new field nodes. I used modules that provided syntax highlighting a module that notified users of new content. I was also able to write SQL queries against the database to extract documentation as data.
The point I am trying to make in case it isn't clear is that a system that comes with plugins and allows you to structure the documentation to suit your organisation is best.
As others have noted, not many developers love documentation. In my experience, it seems to happen in bursts. It's remarkable how useful and relevant a piece of information is even 5 years down the line.
[1]https://www.drupal.org https://www.drupal.org
[2]https://www.drupal.org/project/feeds https://www.drupal.org/project/feeds