编写 README 文档(中/英)

因为代码也是给人阅读的

初级

大约 3 个星期

6小时每周 (自主学习)

加入成千上万的全球学员

开始免费课程

加入课程
免费
可享受
课程视频
实战练习
初级

大约 3 个星期

6小时每周 (自主学习)

加入成千上万的全球学员

课程概述

在本课程中,你将学习什么是文档,为何文档是开发流程的重要组成部分。你将学习如何编写结构清晰的 README,并运用在后续的项目中。学完本课程后,你将能够使用 Markdown 编写自己的 README 文件。此课程提供中文版本。

为什么学习这门课程?

如果你编写过代码或需要检查其他人的代码,你就会知道在没有任何背景信息的情况下,很难读懂代码的含义。

本课程将指导你如何使你的代码更容易让他人读懂,帮助他人最终弄明白你的代码。

先修要求

本课程面向的是任何编程人员或与编程人员合作的人士。唯一的先修要求是:

  • 对 HTML 有基本的了解
  • 对 git 和 GitHub 有基本的了解(有帮助,但不是必须掌握的内容!)

查看使用优达学城的技术要求

学习计划

本课程分成以下三个小阶段:

  1. 文档是什么,面向谁?
  2. 好的 README 具有哪些特征?
  3. 如何使用 Markdown 快速编写 READM?

讲师与合作伙伴

Walter Latimer

Walter Latimer

Walter Latimer 一直是一位活跃的在线替代教育支持者。在加入优达学城之前,他为迈阿密的温科特学院设计了课程大纲,并在 Codecademy 教授初学者编程知识。

官方微信公众号二维码

优达学城(Udacity)微信