diagnostics icon indicating copy to clipboard operation
diagnostics copied to clipboard

doc: define writing practices/rules

Open tony-go opened this issue 3 years ago • 1 comments

During the review of pull request #572, I thought that it could be interesting to have our list of practices/rules when it comes to writing documentation.

It should not be necessary strict rules. It could be an excellent way to onboard new writers easily.

Here is an example of two rules I can extract from my discussion with @RafaelGSS:

  • Simplify code examples as much as you can - for example, prefer using a basic script over an HTTP server.
  • Avoid first-person communication within the documentation

Let me know WDYT.

tony-go avatar Aug 13 '22 05:08 tony-go

This is a good reference: https://developers.google.com/tech-writing

RafaelGSS avatar Aug 13 '22 13:08 RafaelGSS

This issue is stale because it has been open many days with no activity. It will be closed soon unless the stale label is removed or a comment is made.

github-actions[bot] avatar Nov 12 '22 00:11 github-actions[bot]