4 ms·
This is bang on - to get up and running people want examples and some context. For me it's the first thing I look for. On my most recent project I split the do
by petepete 7y ago
This is bang on - to get up and running people want examples and some context. For me it's the first thing I look for.
On my most recent project I split the docs in two; a 'guide' with example code and output - it has more of an 'overview' feel. The other half is the technical (API) docs built from comments in the source code.
It's not the most exciting project in the world, but it's a Rails form builder that meets GOV.UK requirements. Here's a draft of the guide if anyone's interested.
https://govuk-form-builder.netlify.com/ https://govuk-form-builder.netlify.com/
It's generated via Nanoc which loads the form builder and uses it to generate the example input, rendered output and HTML - in theory it can't be out of date or broken.