Documentation · Access Model
MyOpsAgent Documentation & Access Guide
Not every MyOpsAgent document should be public. This guide defines the intended separation between public product documentation, organisation-specific integration material and internal engineering documentation.
1. Public Documentation
Public documentation may explain:
- what MyOpsAgent is and how its major platform layers work;
- the separation between conversational AI and controlled decision authority;
- public integration concepts and security expectations;
- customer onboarding and deployment principles;
- general error handling and safe failure behaviour; and
- research and educational material about governed operational AI.
Public documentation should not contain active credentials, private endpoints, internal administrative routes, database access details or infrastructure secrets.
2. Organisation-Specific Documentation
Authenticated organisation documentation can contain the information needed to configure enabled modules and integrations, for example:
- organisation-specific endpoint configuration;
- credential-management instructions;
- allowed-domain settings;
- module-specific request and response schemas;
- webhook or callback configuration;
- role and permission requirements; and
- deployment information relevant only to that organisation.
3. Internal Engineering Documentation
Internal engineering material should remain access controlled. Examples include:
- production infrastructure and network topology;
- database credentials, schema administration and backup procedures;
- secret names, privileged keys and administrative control paths;
- internal repository and filesystem structures;
- incident response runbooks;
- private deployment procedures; and
- security-test findings.
4. Documentation by Audience
| Audience | Typical Documentation |
|---|---|
| Prospective customer | Platform overview, architecture principles, public research |
| Customer administrator | Onboarding, access, module setup, integration configuration |
| Customer developer | Authenticated API contracts, schemas, credentials and test guidance |
| MyOpsAgent engineering | Internal deployment, infrastructure, security and operational runbooks |
5. Search & Indexing
Only documentation intended for public discovery should be indexable by search engines. Authenticated or internal documents should be protected by access control; robots.txt is not a security boundary.
6. Versioning & Review
Documentation should be reviewed whenever a public capability, integration contract, security control or platform responsibility changes. Public copy should describe current behaviour rather than preserve an obsolete product definition for historical reasons.