Introduction

Introduction

WSO2 API Manager Documentation primarily focuses on end user documentation for product users. It also serves as reading material for analysts and business decision makers such as a company’s CEO, CTO, etc. Therefore, the information architecture and documentation style needs to be consistent and accurate. This document includes guidelines and standards to follow when contributing to the documentation. It is recommended that this document be referred to before contributing to the documentation, in order to maintain consistency across all the documents in the documentation space.

Why Document?

A document helps expose a feature to a broader audience. Unless a document is available, a feature is known to it’s developers and all others involved in the development process only. A document helps bridge this gap. For an end user, a document helps understand the usage, steps and maintenance of the product.

What to Document?

Any aspect that is not intuitive to be done only via the UI or information on using product configurations need to be documented. For example, features involving many steps, learning material, complex configurations, etc.

How to Document?

WSO2 API Manager documentation is available on GitHub. The documentation is done in Markdown. The guidelines and standards to follow can be found below.