Produce a 'style guide' for how Nunjucks documentation is written

[querkmachine]

What

Currently there are various inconsistencies in how we write documentation for the Nunjucks parameters exposed by components. Having discussed this internally, this seems to be because there is a lack of clarity about how certain elements should be described or formatted.

I imagine the most relevant place to put this would be in the contributor docs.

Why

We want our documentation to be consistent and for contributors to know how we expect things to be written—both inside and outside of the team.

Who needs to work on this

• Developers
• Content designer or technical writer

Who needs to review this

• Developers
• Content designer or technical writer

Done when

Research and decision making

Beta Give feedback

1. Collate a list of discrepancies and uncertainties with the current documentation
2. Discuss with content what standards those discrepancies and uncertainties should follow
3. Review the decisions made for technical correctness and to identify any remaining problems

Implementation

Beta Give feedback

1. Draft guidance based on the decisions made
2. Review guidance
3. Publish guidance
4. Update our Nunjucks documentation to resolve any issues rectified by the new guidance