目录
- 1 API程序员
- ▪ 概述
- 2 资格
- 3 API编写过程
- 4 产品
API程序员
API程序员是一个技术人员，主要撰写API应用程序编程接口（API）软件。主要受众包括程序员、开发人员、系统架构师和系统设计师。
概述
API是一个基本的库，由用于构建软件应用程序的接口、函数、类、结构、枚举等组成。开发团队使用它与软件交互和扩展。给定编程语言和系统的API 可能包含系统定义的结构和用户定义的结构。随着这些构造的数量和复杂性的增加，对于开发人员来说，记住所有定义的功能和参数变得非常繁琐。因此，API程序员在构建软件应用程序中扮演着关键角色。
由于技术主题的原因，API程序员必须充分理解应用程序源代码才能提取API文档所需的信息。API程序员使用的一些常用工具包括计算机软件，该计算机软件以结构化的方式提取程序员放置在源代码中的软件文档，从而保留了这些注释与其文档编制的程序之间的关系。
API程序员还必须了解软件平台/产品，并在新软件版本中记录新功能或更改。软件发布的时间表因组织而异。作者需要充分了解软件生命周期，并将自己集成到系统开发生命周期（SDLC）中。
资格
API程序员通常具有编程和语言技能的混合体。许多API作者都有编程或技术写作的背景。
- 计算机编程背景（了解C，C ++，Java，PHP，汇编或其他编程语言）
- 格式化标准知识，例如Doxygen，Javadoc或DITA
- 对编辑器和工具（例如FrameMaker）的了解
- 与开发人员互动的出色沟通和写作技巧
专家API / 软件开发套件（SDK）编写器可以轻松地成为编程编写器。
API编写过程
在编写过程中，大约60％的时间用于分析和理解源代码以及计划文档。其余40％的时间通常将花费在编写和审阅文档上。通常情况下，分析、计划和编写阶段并不是严格按照线性方式进行的。
有效沟通的能力可以很好地补充各种编程技能的良好基础，尤其是当作者寻求与开发人员建立流利的理解水平时。
这个过程是技术作家面临的最重要的挑战之一。组织之间的撰写和评估标准有所不同。一些最有效的API文档是由那些能够充分理解特定应用程序工作原理的人员编写的，因此它们可以将软件与用户相关联，或使各种组件结构与程序的总体目的相关。API程序员也可能至少部分负责编写最终用户产品文档。
产品
API程序员产生的文档包括：
- API参考指南
- 程序员指南
- 开发人员手册
- 管理手册
- 安装指南
- 实施和集成指南
