TiDB Technical Writing Project Ideas

Announcement: PingCAP is applying to participate in Google Season of Docs 2020.

We are dedicated to delivering high quality technical information that is easy to use, easy to understand and easy to find. We are working on it, and your help and support would definitely help!

Interesting fact: We call ourselves Content Strategist because user documentation is only one part of our work scope. If you want to know more, let's get in touch at gsod-tidb@pingcap.com.

Organization overview

This section describes the basic information about our open-source organization:

• Organization name: PingCAP

• Organization description: PingCAP Inc. is a software company founded in April 2015, dedicated to building TiDB, an open-source, distributed, Hybrid Transactional and Analytical Processing (HTAP) database. PingCAP is the primary developer, maintainer, and driver of TiDB and its associated open-source communities. It is a venture-backed company, which announced its 50 million USD Series C round financing in September 2018.

• Reference links:

  • Open-source repository: https://github.com/pingcap/tidb
  • Website: https://pingcap.com

• Email: gsod-tidb@pingcap.com

• Display name:

  • Administrator: lilin90
  • Mentor: Coco

Project ideas

This section describes the project ideas of TiDB documentation in Google Season of Docs.

Project name

TiDB 4.0 Documentation Improvement

Project description

1. Improve the current TiDB 4.0 documentation to make it more user-friendly. This can include reorganizing the content in a single document or within several documents, to make it easier to use and understand.

2. Execute user acceptance tests for TiDB 4.0 how-to guides and tutorials. For example, a technical writer can test a deployment guide's usability by following the instructions step by step and see whether anything needs to be improved (such as updating unclear or outdated descriptions, adding missing steps or necessary information, or refining the content structure). Then, they can file Pull Requests to improve the documentation based on tests.

3. Review GitHub Pull Requests about TiDB 4.0 documentation. This can include reviewing the language and content organization in docs Pull Requests filed by a contributor, a developer, a Database Administrator, or another Technical Writer.

Related material

• The open-source project: https://github.com/pingcap/tidb
• Existing documentation: https://pingcap.com/docs
• How-to guides and tutorials: topics about how to deploy, configure, scale, or monitor a TiDB cluster in different ways
• Related open-source projects that are also involved in the whole TiDB documentation