有效使用技术文档的技巧
文章：Parker Dorris和Lauren Handel，Silicon Labs
设计工程师可以使用这些技巧来有效地使用硬件、软件和开发工具文档。
在开始一个项目时，您要清楚地了解您的设计需求、项目目标和成功的按期启动。也许您是一位领先的物联网(IoT)产品开发人员，正在开发一种新的无线传感器系列。也许你在为工作之外的项目制造无人机。您已经选择了将要使用的硬件和软件开发工具，并且您对自己有信心在学习过程中学习剩下的内容。
开始开发后，您将被吸入密码编译错误，集成开发环境（IDE）的黑洞，以及合规规定。首先，你争夺在供应商的网站上找到有用的文档，然后转向绝望的谷歌搜索。
开发人员经常遇到与文档相关的“Gotcha”时刻导致丧失努力和混乱的日子。您是否曾使用过看似完美的文档中的信息，只能实现它是错误的版本，描述了已弃用的应用程序编程接口（API）？经过几周的发展后如何发现评估板上的产品已被指定为NRND（不推荐用于新设计）？万博投注网址如果这听起来有点太熟悉，现在是时候改变你与技术文档进行搞的时候了。
本文从初始评估中浏览典型的开发人员工作流程，直到设计完成和超越。使用这些提示有效使用硬件，软件和开发工具文档，根据您在开发人员的旅程中需要它们。
在开发之前
根据高质量文档选择供应商，而不仅仅是花哨的硬件。选择供应商可以制作或打破您的开发人员体验，并且在大多数情况下，选择开始选择正确的评估板。只需检查开发板的硬件规格和预期交货日期，可以很诱人诱人，然后点击“购买”。这可能会在项目的开始时为您节省一段时间，但是当您发现文档被混乱，不可读或过时时，您将稍后踢自己。
通过将软件和开发工具文档保持为与硬件数据表相同的标准，从一开始就为成功做好准备。例如,如果你发现一个供应商提供了一个单片机数字外围,可以在一个特定的操作模式,支持应用程序的设计要求,做相应的检查供应商的软件API文档,以确保配置和控制的具体模式是定义良好的。寻找提供教程和介绍的供应商，告诉您如何使用外围功能，以及如何将这些功能集成到项目中。如果供应商提供了针对你的特定细分市场的参考设计材料，还可以加分。
通过“入门”的例子
在开始项目之前，您可能会发现令人生畏的是评估供应商的整个文档集合。逐步回到基础知识，并从看不同的供应商的“入门”指南。
是什么让好的入门指南？
- 指导您完成工具安装，包括代码示例和编译器设置
- 使用新安装的工具获取硬件并运行
- 鼓励您编辑代码，重新编译，并观察更改
那么，一个好的入门指南应该具备哪些条件呢?一个好的向导可以完成以上所有的目标，并让你对接下来的目标有一个清晰的认识。当选择供应商时，缩小你的列表，以那些伟大的入门指南。稍后，在开发中，您可以参考这些指南来了解您正在使用的工具和技术。
版本历史记录
在选择供应商时，请优先考虑那些可以轻松访问其旧版本的堆栈和库的软件文档。例如，当您开发时，堆栈的新版本可能会发布。每当堆栈版本更新时，您必须决定更新或坚持您拥有的版本。
如果您坚持使用您拥有的版本，很重要的是要知道您仍然可以访问与您的堆栈版本相关的文档。对于PDF Sourced Docs，您需要检查修订版本部分。寻找允许您在一个在线平台中访问旧版本的供应商。如果没有在线文档系统或其他一些其他批量Doc下载方法，可以收集特定堆栈版本的所有文档，责任将落在您身上，以收集和保存所需的所有文档。
样本一个doc.
提高文档体验的关键是在开始实施解决方案之前选择高质量，可读和准确的文档。查找您知道的文档将在开发之旅中对您有用。仔细阅读该文件并评估其易读性和组织。
预先嵌入的软件文档的注释是什么样子的?它们是高质量的，可读的，用你的母语写的吗?确保文档提供了可操作的信息，比如如何为特定任务使用外围设备。
开发人员清单
成功的开发人员清单：
- 在购买硬件之前，在供应商中比较和对比文件
- 通过几个入门示例进行工作
- 堆栈发布的同步——您可以访问堆栈文档的旧版本吗?
在开发临近完成时，需要对最新和易于访问的文档不会停止。您花了开发的开端，将概念带到原型，并且将花在市场上的产品的最后一个发展阶段来花费推动到市场准备的产品。在成功启动后，您需要监控更新和通知的文档。选择在整个最终阶段支持开发人员的可靠供应商确保了一个长期存在的产品生命周期。
认证文件
供应商产品提供认证文件以支持其客户在目标市场细分。例如，开发具有无线连接功能的产品意味着要检查软件堆栈组件和模块设计是否通过了各种标准的认证。万博投注网址
并非所有这些文档都将在供应商的网站上提供，因为某些信息可能会在由身体托管的网站上进行认证。寻找提供认证文件的供应商以及对任何非现场资源的指导。
产品生命周期和软件通知
在产品发布后，您或负责采购的人必须警惕并监视产品中每个组件的任何生命周期更新。供应商可能会对您选择的MCU发布一个silicon修订版，而您必须决定是否将自己产品的物料清单(BOM)更新为新的rev。
有时，如果产品达到生命结束（EOL）状态，则不会获得选择，需要重新设计。所有Silicon供应商释放产品更改通知以通知客户的生命周期更新，顶部供应商为客户提供自动订阅和接收通知的能力。
一些供应商为软件(如栈和库)的更新提供类似的订阅服务。例如，您可以订阅安全通知，并相应地快速更新产品的软件，以确保您的产品为客户提供最高级别的安全性。
以下是产品生命周期和软件通知的开发人员清单：
- 订阅产品变更通知(PCNs)
- 寻求提供软件咨询系统的供应商
是例外
开发人员经常浪费宝贵的开发周期，在供应商网站上整理冗长的文档或文章列表，而不是专注于保持他们的项目进度。你可以是例外。在购买开发板之前，确定最好的硬件、软件和开发工具文档。确定支持社区，当你需要他们的时候，他们会给你非常详细和相关的答案。
设计完成后，为您的技术解决方案寻找最新的资质文件。你未来的自己将会感谢你在开发过程中用清晰的时刻取代了数小时的挫败感。
作为一个例子，想象一下你正在开始一个需要的项目蓝牙低能量（BLE）连接。您将Silicon Labs评为一个潜在的供应商及其EFR32BG22片上系统（SOC）作为BLE连接要求的解决方案。从一开始，您将注意到供应商提供培训门户网站，蓝牙上有40多个教育视频。在线平台包括简明为每个开发工具和组织交联API文档的入门指南。
的软件文档平台为所有API文档提供无线协议认证指南，产品发行说明和版本历史记录。在开发后，当您想在产品生命周期上通知时，您可以订阅通知系统，以便在PCN和Errata上保持更新。
Parker Dorris是Silicon Labs Xpress devices的高级产品经理，Lauren Handel是Silicon Labs的产品管理实习生。
相关文章: