“Too often, documentation is written and released once, with no subsequent updates.” - Docs for Developers

1. 在设计阶段进行文档规划

在开始写代码的阶段，就应该想到文档。举个例子，如果开发的新功能会改变API，那么就应该想到更新API文档，来告诉用户API的变化。要实现这一目标，研发和文档工程师需要在设计阶段一起完成用户影响分析。具体来说，需要回答以下问题：

在设计阶段，就进行用户影响分析，可以为文档带来以下好处：

• 避免文档更新不及时

• 避免来不及更新文档

2. 在发版流程中纳入文档发布

要确保文档最终与功能同发，文档工程师应将文档纳入发版流程。

K8s文档同发实践如下：

1. 通过表格列出下个版本要发布的所有特性。

2. 为每一个要发布的特性建一个Github issue，并且带上设计文档、特性负责人、单元测试以及标注是否需要文档。

3. 如果特性标注了需要文档，特性负责人就必须为文档建一个pull request，在发版审批前，必须先完成文档审批。

4. 只有代码、单元测试、文档都通过了，特性才可以提交发布。

5. 在版日，为新版本push所有通过的特性。

在以上实践中，文档和发版是强耦合的，因此确保了文档与功能同发。

要新增 Hexo 文档，可以按照以下步骤：

1. 打开终端或命令行界面。

2. 进入 Hexo 博客所在的目录。

3. 运行以下命令来创建一个新的文档：

   1	hexo new 文档标题

4. 使用任何文本编辑器打开该 Markdown 文件，你可以在其中编写你的文档内容。

5. 保存并关闭文件。

6. 运行以下命令来生成 Hexo 站点：

   1	hexo generate

   这将生成包含新增文档的静态 HTML 文件。

7. 运行以下命令来启动 Hexo 本地服务器：

   1	hexo server

   然后，在浏览器中访问 http://localhost:4000 来查看你的 Hexo 站点，包括新增的文档。

8. 按 CTRL+C 退出。

9. 在 public 目录下执行以下命令通过ossutil脚本将内容上传到 OSS。

   1	./upload_to_oss.sh

   然后，在浏览器中访问 https://tobeatw.com 来查看你的 Hexo 站点，包括新增的文档。
   这样，就成功新增了一个 Hexo 文档。