本课程专为开源开发人员、项目经理和工程师设计,帮助新用户创建包容性文档并促进参与,同时利用特定技能来满足产品独特的 API 文档要求。
本课程专为开源开发人员、项目经理和工程师设计,迎合不同的写作技能,帮助新用户创建包容性文档并促进参与,同时利用特定技能来满足产品独特的 API 文档要求。 课程也欢迎于具有基本编程知识的技术作家参加。
您将学习有效 的API 文档要点,包括不同的文档类型、API 元素、基于代码的参考改进、技术沟通技巧、软件开发中的文档规划以及与作者和编辑协作以增强技术文档。
本课程帮助您做好创建、增强和评估产品文档的准备。 完成课程后,您将能够规划高质量的文档,有效地传达信息,并作为主题专家与作者合作,将技术知识有效地传递给用户。
课程特点:
● 在线,自主学习
● 3-4小时学习内容
● 含小测试
● 注册后12月内有效
经验水平:初级
目录:
单元1. Course Introduction
单元 2. Creating Effective API Documentation
单元 3. Contents of an API Documentation Suite
单元 4. Supporting the Documentation Effort
此课程为Linux 基金会官方原生课程,课程语言为英语。
Linux基金会开源软件学园 Copyright © 2019-2024 linuxfoundation.cn, ICP license, no. 京ICP备17074266号-2