Resources
This section introduces useful resources and documentation that will help you in terms of document preparation and review.
Internal Resources
-
EMoS Training Video is a series of training videos prepared by the Documentation team which introduce the basic rules of writing provided in EMoS. In these videos, you will learn which rules are applicable to Chinese, and which are applicable to English by analyzing typical examples we encountered at work. You will also know the background and reasons behind making these rules, getting convinced to adopt them.
-
Espressif Term Base lists technical terms frequently used in Espressif documentation in alphabetical order.
Each term has a definition to point out exactly what is understood by the term. Both English definition and Chinese difinition are supported. Please pay attention to definitions and avoid interchangeably using terms that have different meanings or are reserved for different purposes.
Espressif Technical Writing Guidelines
The Espressif Technical Writing Guidelines are a comprehensive resource for creating clear, consistent, and professional technical documentation. Designed specifically for Espressif’s needs, these guidelines help writers, editors, and reviewers produce high-quality documentation that enhances readability, ensures consistency, and reflects our commitment to excellence.
External Resources
Merriam-Webster’s Collegiate Dictionary
The dictionary by Merriam-Webster is America’s most trusted online dictionary for English word definitions, meanings, and pronunciation. It is recommended to refer to it or other authorized dictionaries whenever you have doubt about vocabulary spelling or usage.