I'm working on the creation of a software and product documentation in a wiki format. It will include the documentation for all the company products.
After some research, we decided to use the MediaWiki platform and create a private wiki accessible from our internal network.
This documentation will include mainly software artifacts for now:
- Database Diagrams;
- Data Dictionary with database meta-data;
- Short description of the product;
In the future, it will also include:
- UML artifacts and diagrams;
- Use cases;
- Help pages for support team;
- Bug reports;
- Statistics information around the product;
- Test guides;
The wiki structure is not a problem, but my first thought was block some pages to some specific users. Apparently, that's not possible using MediaWiki, so anyone in our internal network will can visualize all the documentation, although they can not edit.
My question is: Are there any problem in keep this documentation public for anyone in the company? I mean, the software docs are important for the developers and technical teams, but the sales team, for example, does not need to see all these pages, right? The statistical data should be accessible for developers? It should be public?
The documentation will not include any sensitive data, like keys or passwords, but I'd like to know if there are some standard approach on the documentation access in large companies.
Based on the comments, here are some updates:
I explained the whole picture, but I'm specially concerned about possible problems with unauthorized access to software documentation.
When I started the documentation project, I thought that hide some parts could be a good approach, but thinking (and searching) about it, I don't found a pattern.
So, my question is about any standard (or recommended) approach used by software engineers to deal with (internal) software documentation. Are there any?