|
所在平台: Udemy |
课程主页: https://www.udemy.com/course/the-art-of-api-documentation/
课程评论：没有评论
**Coursera 课程总结：API 文档的艺术** 本课程是面向技术写作者的 API 文档系列课程的第三部分，旨在教授如何撰写 API 的概念性文档。在前两门课程“学习 API 技术写作：JSON 和 XML”（以及“学习 API 技术写作：REST”）的基础上，本课程将深入讲解 API 文档中至关概念性部分的写作技巧，包括概览、入门指南和教程等。 **课程内容亮点：** * **概念性文档撰写：** 教授如何撰写解释 API 核心概念、用户场景和最佳实践的内容，帮助开发者快速上手。 * **RESTful API 实践：** 演示如何使用 GUI 和命令行工具进行 RESTful API 请求，并提供相关工具的使用指南。 * **优质示例代码：** 提供撰写清晰、易于理解的示例代码的指导原则。 * **开源项目实战：** 指导如何寻找开源项目进行文档撰写，为进入 API 写作领域提供实践机会。 * **学习资源：** 包含 8 个视频讲座、2 个动手练习（REST 请求）、课程讲座的 PowerPoint 演示文稿以及一份寻找开源项目的资源 PDF。 **课程目标：** 学完本课程后，学员将能够： * 掌握撰写高质量 API 概念性文档的技巧。 * 熟练使用工具发起 REST API 请求。 * 了解如何为开源项目贡献 API 文档，从而进入该领域。 **课程建议：** 建议在学习本课程前，先完成“学习 API 技术写作：JSON 和 XML”以及“学习 API 技术写作：REST”课程，除非您已对 API 文档和参考资料文档撰写有深入了解。 **课程时长：** 约 1 小时 30 分钟（根据练习速度而定）。 **API 简介：** API（Application Program Interface）是软件系统间通信的接口，API 文档是当前技术领域需求旺盛且高薪的专业领域，能够帮助软件开发者理解和使用 API。本课程将帮助您站在技术前沿，掌握这一热门技能。
Course DescriptionThis is the third in a series of courses for technical writers who want to learn how to write API documentation. The first two courses are called "Learn API Technical Writing: JSON and XML for Writers" and "Learn API Technical Writing: REST for Writers", and it's recommended that you first take those courses, unless you are very familiar with API documentation, and how to document reference material.This course teaches how to write conceptual API documentation, such as overviews, getting started sections, and tutorials. For the most part, no programming experience is required, but technical writers with programming experience will still find it useful.In addition to conceptual material, this course covers guidelines for good sample code, tools for making REST requests, and how to find an open source project to document as a way to get into the field of API writing.What are APIs?APIs (Application Program Interfaces) define how software systems talk to each other, and API documentation is a rapidly growing field. There is a strong need for writers who can understand APIs and explain them so that software developers can understand how to use them. API writers get to be in on the cutting edge of technology in high-paying positions.What is Conceptual Material?API documentation consists of reference material and conceptual material. Reference material describes the details of the API: what are the pieces of each request and response, or each class and member. Conceptual material orients developers so that it's easy for them to get started with a new API. What is in This Course?By the end of the course, you will understand how to write good API conceptual material, how to make REST calls using GUI and command-line tools, and how to find an open source project to document. In this course you'll find: 8 videos that: Describe how to write good conceptual material Provide guidelines for good sample code Demonstrates how to use tools to make REST calls Leads you through examples of how to find open source projects on the internet 2 hands-on exercises to lead you through making REST requests using tools PowerPoint presentations as a resource for every video lecture A PDF with resources for finding open source projects The course takes approximately 1 hours and 30 minutes to complete, depending on how fast you are with the exercises.
