このページは、まだ日本語ではご利用いただけません。翻訳中です。

Content templates

At Kong, we use the following four standard content types when we write our documentation:

• Explanation: Documentation that is understanding-oriented because it clarifies and discusses a particular topic.
• How-to: Documentation that is goal-oriented and prescriptive and that takes readers through the steps to complete a real-world problem.
• Reference: Documentation that explains the technology, like API or command line documentation.
• Tutorial: Documentation that helps users learn about a topic by going step-by-step through a series of tasks.

To help anyone interested in writing documentation, we have created templates for the individual content types:

• Explanation
• How-to
• Reference
• Tutorial

Plugin documentation follows its own specific format, regardless of content type:

• Template for Kong-owned plugins
• Template for partner plugins