External services documentation

Service360 strongly believes that in order to steer platform evolution efficiently one must have as full understanding of the landscape as possible. Most of the landscapes nowadays have some sorts of dependencies on the services external to them: payment providers, ERP systems, 3rd party goods suppliers, and such.

One pattern that we find useful in documenting such dependencies is External Services repository.

Example of such a repository you can find in the SampleOrg.

As you can see this repository is nothing more as a collection of folders with external services documentation paired with a Service Passport for each of the folder/service. Each external service is marked with Type: External passport section. This type value (external) not only allows to visually separate those services in the S360 interface, but also disables all risk checks for those services.

We recommend to create such a repository and use it for enumeration of the external dependencies of your platform as well as for keeping track of useful documentation, how-tos, know-hows, etc.

How to set it up

Create a repository and add it as a separate Source for your library.

As the source type use “Mono repository”. We would also recommend to disable Releases and Contributors collection. Usually those would not make much sense in the context of the external dependencies

Example setup. Sources list

Example setup. Mono repo setup