About This Document
The Espressif Manual of Style is intended to promote established practices in Espressif documentation and help Espressifers seeking advice on the topics related to documentation development.
Note
The Espressif Manual of Style, primarily intended for internal reference within Espressif, is publicly accessible for ease of use. Internal resources are intentionally not hyperlinked to maintain confidentiality. Please follow the provided navigation paths within the document to access these resources.
Release Notes
Version 1.11 (Dec 2024)
Added Chapter Admonitions
Version 1.10 (Dec 2024)
Added Chapter Mathematical Expressions
Updated Section When to Use En Dashes and Section Time and Date Ranges to clarify which punctuation mark should be used for indicating ranges
Version 1.9.1 (Aug 2024)
Added Section Choosing Image Formats in Pictures and Diagrams
Version 1.9 (July 2024)
Added Chapter Watermarks
Version 1.8.2 (May 2024)
Added EMoS Quick Reference Guide and EMoS 快速参考指南
Added Section When Referring to Quantities in a List in Numbers
Version 1.8.1 (Feb 2024)
Removed all links to internal resources
Added a note in About This Document and homepage to explain the removal of internal links
Version 1.8 (Apr 2023)
Updated Section Point of View
Added Section Numeral Systems
Version 1.7.4 (Oct 2022)
Updated Resources to add links to useful resources and documentation
Version 1.7.3 (Aug 2022)
Updated three sections:
Section Heading Titles
Section Quotation Marks
Section Cross-References in Chinese Text
Added Section Software and Hardware Modes
Version 1.7.2 (May 2022)
Updated Section Heading Titles and the notice in Section When to Use Hyphens
Version 1.7.1 (Apr 2022)
Added links to EMoS Quick Reference Guide
Updated three sections:
Section When to Use Hyphens
Section Rules of Using Commas
Section FANBOYS Conjunctions
Version 1.7 (Jan 2022)
Added Chapter Writing Instructions
Version 1.6 (Sep 2021)
Fixed typos and broken links
Edited all the “V” standing for “version” to lowercase “v”
Added two sections:
Section When to Use Plus Signs
Section On the Number of Verbs
Added the example of “读/写” in Section General Rules
Added the rule about when to add spaces around the ampersand “&” in Section General Rules
Added the “RESTRICTED” watermark
Version 1.5 (Dec 2020)
Updated Disclaimer and Copyright Notice
Removed link to Espressif Product List
Version 1.4 (Aug 2020)
Added Section Rules of Using Commas
Updated links to templates in Chapter Pictures and Diagrams
Version 1.3 (Mar 2020)
Added new chapters:
Chapter Time and Dates
Chapter Tables
Chapter Avoid Common Chinglish
Updated Chapter Pictures and Diagrams
Fixed some inconsistencies across chapters
Updated the formatting of tables in accordance with the new chapter
Version 1.2 (Nov 2019)
Added Chapter Pictures and Diagrams
Version 1.1 (June 2019)
Updated links to Espressif Product Names and Espressif Term Base
Version 1.0 (May 2019)
Release 1