Greetings, everyone. My name is Chen Meng and I am the leader of the technical documentation team at Shengwang. It is an honor for me to share my experience and insights with you at tcworld 2023.
Having worked at SoundNet for many years, my team and I are committed to providing developers with the best technical documentation experience possible. We strongly believe that clear, concise, and understandable documentation is the foundation of a developer’s success. Consequently, we have been working tirelessly to improve the quality of our technical documentation and are constantly exploring new ways and tools to help developers.
During this speech, I will discuss the exploration and selection of technical document writing, review, and publishing tools by my team and me over the past few years. Additionally, I will share some of the good practices and tools we have discovered. It is my hope that our experiences will provide you with inspiration and insight, leading to increased mutual exchange and communication.
All Sessions by Meng Chen
Ideas for Selecting Developer Documentation Tools: From Self-Developed CMS to Open-Source Frameworks
14:00 - 14:45
Agora is a PaaS company that specializes in assisting developers with integrating real-time audio and video interaction functionalities into their applications. Its primary products include SDKs, components, and scenario solutions based on SDKs and components.
The documentation team at Agora is responsible for creating a diverse range of content, including product overviews, API references, quick start guides, feature guides, scenario solutions, and best practices. With such a large volume of documentation, and varying content types, achieving consistent content across multiple platforms while keeping up with business requirements is an ongoing challenge. As a team, we have been working tirelessly to find a more suitable documentation tool chain that meets our needs. We have gone through several phases, from self-developed CMS and "code documentation," to structured writing for API references, and even using open-source frameworks for "documentation coding." The process has been filled with both challenges and rewards, and as our tool chain continues to evolve, we are slowly changing the documentation-development collaboration relationship.
Through this presentation, I will review the cases, experiences, and lessons learned by the Agora technical documentation team throughout our tool selection process. My aim is to provide you with inspiration and ideas for your own documentation endeavors.
The premier gathering event for all decision-makers and specialists in the field of technical communication in China.