Tightening the text slightly. Previously, some sentences had been deliberately "untightened" as per guidance on writing technical docs potentially for non-native English speakers. I think the introductory paragraphs on the first page of the docs are slightly special in that they function as a sales pitch rather than purely "dry" documentation so the needs here are different.
Avoiding some unnecessary technical language ("command line interface", "application domian").
Linking directly to some examples for those who just want to see the thing.
This involves a few changes:
Tightening the text slightly. Previously, some sentences had been deliberately "untightened" as per guidance on writing technical docs potentially for non-native English speakers. I think the introductory paragraphs on the first page of the docs are slightly special in that they function as a sales pitch rather than purely "dry" documentation so the needs here are different.
Avoiding some unnecessary technical language ("command line interface", "application domian").
Linking directly to some examples for those who just want to see the thing.
Preview URL: https://evansd-intro-para.databuilder.pages.dev/
Associated Slack thread: https://bennettoxford.slack.com/archives/C069SADHP1Q/p1717578791863539