© Thomas Hunter II 2017

Thomas Hunter II, Advanced Microservices , 10.1007/978-1-4842-2887-6_8

8. Documentation

Thomas Hunter II

(1)San Francisco, California, USA

Writing documentation is vital to the success of a service. If consumers don’t know how to use your service, they won’t use it. This is applicable to both services available to the public and those used only within an organization.

Good Documentation Principles

Make your documentation available to the public and search engines. Keeping documentation hidden behind a login prompt will have a few detriments. Developers won’t be able to find documentation using a search engine, developers will be annoyed when they have to log in and navigate to the docs again, and potential developers won’t ...

Get Advanced Microservices: A Hands-on Approach to Microservice Infrastructure and Tooling now with the O’Reilly learning platform.

O’Reilly members experience live online training, plus books, videos, and digital content from nearly 200 publishers.