Get the latest tech news
We fixed our documentation with the Diátaxis framework
Diátaxis recently made the front page of HN. I mentioned in a comment that we applied the framework to Sequin a couple weeks ago and were very happy with it. Some folks asked me to expand on my comment, so I'm doing so here: The engineer's documentation fallacy Engineers often
They start with hands-on learning(tutorials), move to solving specific problems(how-tos), dive into details as needed(reference), and finally explore deeper understanding(explanation). Our quickstart cuts right to creating a sink (e.g. webhook endpoint) and seeing changes flow from the source table to the destination. Whenever we felt the urge to explain a concept, we'd create a "phantom link" to a non-existent reference page.
Or read this on Hacker News
