Within an enterprise documentation system, a system of facts (SoF) is one that stores the state of the enterprise and that allows access to such data through structured means (database access, APIs, file parsing, and so on). Systems or facts are a superset of system of records (SoR) given that they also include enterprise collaboration applications and analytical platforms, and configuration files.
Some examples of systems of facts are:
SoFs versus Specialist Documentation Platforms
Most SoFs have a user interface, and as far as the domain SMEs are concerned, part of their ādocumentationā lives indeed in such systems. Thereās no reason as to why a system of fact couldnāt act as a specialist documentation platform and vice versa. The following table provides some guidance as to whether an SoF may also be considered a specialist documentation platform.
Aspect | SoF Only | SoF and Specialist Documentation Platform |
---|---|---|
Access credentials | System-specific | Same SSO credentials as the main documentation platform |
Access permissions | Only domain SMEs | Most participants as those who can access the main documentation platform (at least in read-only mode) |
UI | Installable desktop application | Web-based access, with specific content areas being uniformly addressable so that they can be connected with the rest of the enterpriseās body of knowledge. |
DocOps Automation
Systems of facts are the easiest systems to integrate in DocOps automation workflows because they inherently provide direct database access, API-based integration, or files in a structured format (configuration, programming language source code, etc). The DocOps effort entails finding the relevant systemās endpoints, gaining access permissions, looking up the schema or interface specification, and then deciding what the most appropriate way to embed and blend the data is, depending on the chosen intermediate document format.
© 2022-2024 Ernesto Garbarino | Contact me at ernesto@garba.org