Note:
This topic has been translated from a Chinese forum by GPT and might contain errors.Original topic: 【 TiDBer 唠嗑茶话会 38 】关于文档的爱恨情仇，统统可以在这里倾诉~
|
username: Billmay表妹
Preface
In the TiDB Community, TiDBers continuously offer suggestions for document optimization. Since the launch of the Document Optimization section, we have collected 70 pieces of feedback regarding document errors and needs. Out of these, 68 suggestions have been accepted and fully implemented, with the remaining 2 still being optimized…
As the product iterates, the importance of documentation becomes increasingly evident. Complete, detailed, and easy-to-understand documentation is often a powerful tool for TiDBers to handle TiDB issues.
We are well aware of the shortcomings of the existing documentation and the vast amount of content that needs optimization and iteration. The priority and level of detail for new documentation need to be planned reasonably according to TiDBers’ needs. Therefore, through this survey, we hope TiDBers can provide case by case documentation suggestions and work with the documentation team to refine the documents, helping more TiDBers tackle and solve technical problems encountered in daily work.
This Topic:
Leave case by case factual examples of documentation optimization needs in the comments section.
If you encounter the following issues:
- Documentation errors
- Some parts of the documentation are unclear
- Missing explanations for certain parts of the documentation
Submit your feedback according to the following process:
Documentation Errors
If you encounter documentation errors, please provide feedback using the template below. This will help us locate the issue more quickly and make modifications promptly:
- Issue Category: Outdated information, description errors, code errors, parameter errors, link errors, typos
- Affected Page: Link + Screenshot
- Error Description:
Unclear or Incomplete Documentation
If you find some parts of the documentation unclear, please submit feedback using the template below to help us understand your confusion better:
- Issue Category: Content too brief, unclear or ambiguous descriptions, incomplete steps
- Affected Page: Link + Screenshot
- Problem Description:
New Documentation Needs
If this is a new documentation need, please submit feedback using the template below to help us understand your needs more quickly and optimize accordingly:
- Request Type: New documentation
- Background: For example, which part of the documentation is missing and how it affects usage
- Expected additions to components or functions in the existing documentation and where to add them
Feedback Rewards:
- One participant who provides feedback will be randomly selected to receive a new TiDB backpack, and another will receive a limited edition TiDB Cloud mug.
- Participants who provide feedback according to the template will receive 100 points and 100 experience points.
- All feasible suggestions will be implemented.
TiDB New Backpack
TiDB Cloud Limited Edition Mug
Participants who do not follow the template will not be eligible for rewards in this chat session.
|
username: 
|
username: 
|
username: 
Does this student have a misunderstanding about TiDB Server~ This is a service component, not a server.
|
username: 
|
username: 
|
username: 
|
username: 
|
username: 
|
username: 
|
username: