Documentation: Better documentation
planned
Greg DeVore
The different modules have very little documentation, especially the custom tools, which makes setting up new configurations very frustrating.
Log In
D
Darin Patterson
planned
Thank you for sharing your feedback and ideas on how to improve our documentation.
We have recently built a brand new documentation team here at Make, which is now working hard on delivering some much needed improvements. Our mission is to provide complete, relevant, accurate, and consistent documentation that is helpful.
For starters, all new features that become available in Make going forward will have detailed documentation released in the Help center, including release notes, user guides, and reference information.
As suggested in this discussion, we will add explanations, instructions, and examples to the documentation for Make's most powerful platform features, such as routers, iterators and aggregators, filters, error handlers and other key features.
We are also working hard on expanding the API documentation to cover yet undocumented endpoints and parameters.
Stay tuned for these updates to be rolled out gradually over the course of the year.
Matthew Shane
Is this still "planned"??? It's been almost 18 months - certainly by now improved documentation should be ready to reveal?
Siegfried Sekkai
For Example, the curl for POST/scenarios is unreadable in Postman.
Moreover it returns a
{
"detail": "Validation failed for 3 parameter(s).",
"message": "Bad Request",
"code": "SC400",
"suberrors": [
{
"message": "Missing value of required parameter 'teamId'.",
"name": "Error"
},
{
"message": "Missing value of required parameter 'blueprint'.",
"name": "Error"
},
{
"message": "Missing value of required parameter 'scheduling'.",
"name": "Error"
}
]
}
There's no specifications for those parameters
D
Darin Patterson
planned
Thank you for sharing your feedback and ideas on how to improve our documentation.
We have recently built a brand new documentation team here at Make, which is now working hard on delivering some much needed improvements. Our mission is to provide complete, relevant, accurate, and consistent documentation that is helpful.
For starters, all new features that become available in Make going forward will have detailed documentation released in the Help center, including release notes, user guides, and reference information.
As suggested in this discussion, we will add explanations, instructions, and examples to the documentation for Make's most powerful platform features, such as routers, iterators and aggregators, filters, error handlers and other key features.
We are also working hard on expanding the API documentation to cover yet undocumented endpoints and parameters.
Stay tuned for these updates to be rolled out gradually over the course of the year.
sthe
Setting up an OWN APP is almost non existent. Especially the URL / Auth parts with a dynamic connection.
Shivam Bhateja
There seems to be a lot of power here, but documentation have no idea how to utilize it.
Stella
I find short videos really helpful, but the current robot voice and music are a bit distracting. Would like to have explanations on equivalent features and functions to Zapier so that it's easier to move across.
Ryan Knowles
More examples for error handling. There seems to be a lot of power here, but I have no idea how to utilize it.
Alex Chekalov
You can find a video FAQ series here https://loom.com/share/folder/b127db450b2b43e9962b4627558780b9
Ryan Knowles
Alex Chekalov: Bad link.
Mike Kinde
Alex Chekalov: Link is still bad
Specialty Toys
In the absence of a wiki, it would be valuable to have a form at the bottom of each documentation page where people can submit comments on what they think needs to be improved about that particular documentation page. Right now we have the ability to vote, but that really doesn't provide anyone with real information aside from "this documentation is poor". As suggested elsewhere though, tapping into the community (possibly through a wiki) would go a long way towards quickly beefing up your documentation.
Kurt Anderson
Have you considered making the instructions like a wiki, where the entire community could assist with improving the documentation? That way each of us can solve each pain point just once, and everyone benefits? If you look at the developer documentation in Intercom, for example, each page has a link in the upper right allowing just this sort of community editing.
Specialty Toys
Kurt Anderson: I'm not sure how the moderation of this would work, but I think allowing the community to participate in building wiki-style documentation and examples would be hugely valuable. @integromat please leverage us, your adoring community!
Kurt Anderson
Specialty Toys: I imagine that it's a feature of whatever CMS they might be using to create their documentation. I don't have a clue what Integromat is using, but if it requires a rewrite, it's probably a non starter. I hope it's relatively simple for them to implement, then it's off to the races!
Tim Fong
Kurt Anderson: Confluence could be added, or PBwiki
Load More
→