Shared best practices for writing up examples in specs and documentation

mdn / pab

MDN Web Docs Product Advisory Board

26 stars 17 forks source link

Shared best practices for writing up examples in specs and documentation #22

Closed dontcallmedom closed 5 years ago

dontcallmedom commented 6 years ago

Similar to #21, I think MDN has probably accumulated (formally or informally) lots of best practices as to what constitutes a good introductory example - it would be useful to get these best practices shared with W3C groups and editors.

chrisdavidmills commented 6 years ago

@dontcallmedom the guidelines you want are here:

https://developer.mozilla.org/en-US/docs/MDN/Contribute/Guidelines/Code_samples
https://developer.mozilla.org/en-US/docs/MDN/Contribute/Guidelines/Writing_style_guide#Code_sample_style_and_formatting

chrisdavidmills commented 5 years ago

I think this can be closed.