Skip to content

doc: define writing practices/rules #578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tony-go opened this issue Aug 13, 2022 · 2 comments
Closed

doc: define writing practices/rules #578

tony-go opened this issue Aug 13, 2022 · 2 comments
Labels

Comments

@tony-go
Copy link
Member

tony-go commented Aug 13, 2022

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.

@RafaelGSS
Copy link
Member

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

@github-actions
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants