| 2020-09-13 17:17:19 |
Mayur Patil |
description |
In my opinion, we should follow either Chicago Manual of Style or Microsoft Style Guide.
It will help us to save a lot of time and improve clarity and correctness of technical documentation. Please let me know about your opinions.
This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:
- [ ] This doc is inaccurate in this way: ______
- [X] This is a doc addition request.
- [ ] I have a fix to the document that I can paste below including example: input and output.
If you have a troubleshooting or support issue, use the following resources:
- Ask OpenStack: https://ask.openstack.org
- The mailing list: https://lists.openstack.org
- IRC: 'openstack' channel on Freenode
-----------------------------------
Release: on 2020-09-03 15:02:43
SHA: b7e6f5279be5b05bb8e5459d44add04fd093444d
Source: https://opendev.org/openstack/openstack-manuals/src/doc/doc-contrib-guide/source/writing-style/general-writing-guidelines.rst
URL: https://docs.openstack.org/doc-contrib-guide/writing-style/general-writing-guidelines.html |
In my opinion, we should follow either Chicago Manual of Style or Microsoft Style Guide.
It will help us to save a lot of time and improve clarity and correctness of technical documentation. Please let me know your opinions.
This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:
- [ ] This doc is inaccurate in this way: ______
- [X] This is a doc addition request.
- [ ] I have a fix to the document that I can paste below including example: input and output.
If you have a troubleshooting or support issue, use the following resources:
- Ask OpenStack: https://ask.openstack.org
- The mailing list: https://lists.openstack.org
- IRC: 'openstack' channel on Freenode
-----------------------------------
Release: on 2020-09-03 15:02:43
SHA: b7e6f5279be5b05bb8e5459d44add04fd093444d
Source: https://opendev.org/openstack/openstack-manuals/src/doc/doc-contrib-guide/source/writing-style/general-writing-guidelines.rst
URL: https://docs.openstack.org/doc-contrib-guide/writing-style/general-writing-guidelines.html |
|
