You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently the documentation for environments varies from environment to environment. Most of the environments lack info on common questions users have: How do I setup this environment? Which version should I use? What is the latest version of environment? Does it have a builder? Does it support functionality X?
We should ensure that the documentation is sufficient enough to help the user with these questions, which otherwise confuse the user at runtime and lead to pressure on the support.
I think it would help if we have some sort of a template or checklist what should be in the environment documentation. From the top of my head we should consider it to constitute of the following should be in there:
Cut-and-paste examples of most recent version
A table indicating what functionality is supported (builder, V2, V3, etc)
Links to examples
Build instructions
Some text on the functions./usage: how to set response code, how to get headers, body, and query params. What happens on exceptions?
Known issues/FAQ
Changelog on changes made to the environment
The text was updated successfully, but these errors were encountered:
Currently the documentation for environments varies from environment to environment. Most of the environments lack info on common questions users have: How do I setup this environment? Which version should I use? What is the latest version of environment? Does it have a builder? Does it support functionality X?
We should ensure that the documentation is sufficient enough to help the user with these questions, which otherwise confuse the user at runtime and lead to pressure on the support.
I think it would help if we have some sort of a template or checklist what should be in the environment documentation. From the top of my head we should consider it to constitute of the following should be in there:
The text was updated successfully, but these errors were encountered: