To practice Markdown
成立于 2008 年的无晶圆厂半导体公司，多年来深耕 AIoT 智能物联领域，已成为全球物联网行业的领航者。乐鑫专注于研发性能卓越、安全稳定节能的无线通信 SoC，现已发布 ESP8266、ESP32、ESP32-S、ESP32-C 和 ESP32-H 系列芯片、模组和开发板，成为物联网应用的理想选择。（芯片、模组和开发板，硬件资源逐渐完善，芯片缺乏时钟源和flash，不能直接开发；模组在芯片的基础上添加了运行程序的基本条件，还要加上接口；对开发板进行开发只需要将usb连接电脑） 自主研发了一系列开源的软件开发框架，如操作系统 ESP-IDF、音频开发框架 ESP-ADF、Mesh 开发框架 ESP-MDF、设备连接平台 ESP RainMaker、人脸识别开发框架 ESP-WHO 和智能语音助手 ESP-Skainet 等，以此构建了一个完整、创新的 AIoT 应用开发平台。
- 创新研发能力，成立于2008年，乐鑫多年来深耕智能物联领域，开发了许多智能且应用广泛的芯片和模组（智能家居、电工、照明、智能音箱、消费电子、移动支付等领域）并实现系列产品的快速迭代
- 以用户需求引领创新研发，提供性能卓越的硬件设备，安全、稳定、节能的软件解决方案
- 绿色、开放、共享的理念，通过科技创新节约能源，自主研发了一系列开源的软件开发框架，支持许多创客社区的开源项目，通过技术共享促进社会的智能化
- 结构：易于导航、内容组织有逻辑，重点突出 heading, subheading, bullet points
- 内容：简洁易读，内容格式风格前后一致，无错误
- 排版：留白合适、良好阅读体验
- 用户意识
- 图表及视觉辅助
- 公司信息介绍栏以及子标题 Chinglish 有的表达不正式，像：“我们是谁，我们做什么，我们的哲学（应该是理念）”
- 各内容的段落间距、图文排版，有的未左右对齐
- 背景颜色白色，阅读体验不佳，显得单一乏味、不利于信息获取
- 交互性弱，“里程碑”时间由近到远，没有年份快速筛选功能，信息获取效率不高
- ESP32-S3-BOX 多配件，扩展功能多样，低功耗。可实现无线连接，应用于智能家居，支持触屏控制、人机语音交互
用户指南 一处错误 function button，试着提交pull request， git clone 时git报错 PRC failed，缓存区溢出，需加大缓存区 git config --global http.postBuffer 1048576000(1G)
- ESP32-S2 是一款高集成度的低功耗 Wi-Fi 系统级芯片 (SoC)
浏览了硬件设计指南，包括文档说明，目录，产品概述，设计原理等介绍，修订历史，底部有反馈文档意见。文档用什么工具写？电路图的配图，制作图用的工具，
- ESP-SR 声学前端算法，消除回声、抑制噪音算法、基于神经网络的唤醒词模型
- ESP rainmaker
- 翻译、编辑和维护公司文档，持续输出符合公司标准的高质量内容
- 深入了解乐鑫的各类产品，并将复杂的产品信息转化为简单明了、结构清晰且引入入胜的内容
- 维护、开发并优化团队的文档风格标准、模版、指南、工具和工作流程
- 直接与产品开发团队合作，收集信息并翻译或更新文档；编辑并标准化各类主题专家起草的文档，并相互审阅其他团队成员提供的内容；完成中英和英中翻译；协助规划文档内容的交付，并及时沟通进度和风险
- 学习公司和公司产品的内外部资源，与开发工程师、主题专家和产品经理一起审查产品细节，以提供准确、切题且易于使用的文档
- 协助开发文档标准、模板、工具和工作流程，帮助团队更好地交付文档
- 懂得Markdown，是一种标记语言，编写文档时兼顾内容与格式，使用起来较为便捷，以markdown语法编写的内容可以以html格式发布
- 学习能力，csdn网站和b站教学视频自学了github的基础知识，github是远程仓库，用于保存代码等文件，可开放共享，便于多人协作开发同一个项目。repository，branch熟悉基本操作，fork，commit和pull request。
- 技术文档写作要求 tech writer
- 乐鑫的员工必须专业，必须敢于创新，但更重要的是能学习新东西、学习新技术。
技术文档风格规范 [style guide](https://github.com/yikeke/zh-style-guide/tree/master/source “点击前往外部站点”)
目的：提高中文文案的可读性，统一文档风格，保证公司对外输出形象一致
- 命名产品，建立统一的产品名称表
- 文档质量检查工具grammarly， visual studio code插件
- 文档内容元素（代码块，列表的使用规范：使用相似的句子结构、句子长度相近、标点一致、描述话语清晰简洁，图片：清晰、图片上若有字做好本地化、文字选择免费开源可商用的、中英文文字字体统一、图说明和图尽量一页、添加替代文本，引用规范，）
- 文档结构样式 句子标题段落目录
- 标点符号
- 语言风格 技术文档的首要目的是向读者传达技术信息，因此
| 语言风格要求 | 具体内容 |
|---|---|
| 保持客观礼貌简洁 | 拉近与读者的距离，禁止啰嗦冗长、逻辑混乱。不轻易使用感叹号、反问号，不要轻易使用“请”、“抱歉”，不过多穿插玩笑（适当展示公司的个性，使人印象深刻）避免使用亲切的称呼。 |
| 推荐使用对话式 | “你可以”，并保证全文人称代词一致。 |
| 以用户为导向 | 考虑文档受众的技术水平分布，对于操作型技术文档，除语言审校外，建议继续进行文档可用性测试，由一位无技术背景的测试人员参照该文档进行完整操作，如操作顺利成功，则该文档可用性测试通过；如失败，则需要继续修改完善文档。对于操作型技术文档，不仅要准确描述操作步骤，还应设身处地考虑用户可能面临的问题，提供进一步的详细信息。例如，对于需要输入的信息，提供输入格式等详细要求；对于报错信息，提供解决报错的可选操作；为方便用户排查错误，提供详细的错误码速查列表等等。 |
| 用词恰当 | 描述产品、商品时不使用“最佳”、“最好”“最先进水平”等具有强烈评价色彩的词语，不使用俚语、网络流行语、行话黑话，如果产品文案中涉及多地域或可用区，需正确使用涉及中国领土、主权和港澳台的词汇，建议用具体的数据或实例代替表示程度、强调语气的词“很好地提升了性能”“性能提升了 50% 或者延迟从 10ms 降为 1ms”。 |
| 尽量使用主动语态 | 尽量使用主动语态 |