周报-28｜技术文档范例

chensoul   review

前言

本篇是对 2023-07-10 到 2023-07-16 这周生活的记录与思考。首发在我的个人 博客，你可以移步了解更多或者给我留言。

读书、健身、投资、帮朋友、陪家人。

这是我的第 27 篇周报，由于工作的原因，前两周的周报是一起发布的，所以第 27 篇周报被跳过去了。

技术文档范例

以下是一个使用中文标题的技术文档范例：

一、介绍
    1.1 目的
    1.2 范围
    1.3 受众
    1.4 定义、缩略语和术语
二、概述
    2.1 系统架构
    2.2 主要功能
    2.3 系统要求
三、入门指南
    3.1 安装
    3.2 配置
    3.3 第一步操作
四、用户指南
    4.1 用户界面
    4.2 导航
    4.3 功能
五、管理指南
    5.1 系统配置
    5.2 用户管理
    5.3 安全性
六、故障排除
    6.1 常见问题
    6.2 错误消息
七、附录
    7.1 发行说明
    7.2 术语表
    7.3 参考文献

以下是一个使用数字标题的 Spring Cloud Gateway 教程示例：

1. 介绍
    1.1 目的
    1.2 范围
    1.3 受众
    1.4 术语和定义
2. 概述
    2.1 什么是 Spring Cloud Gateway
    2.2 Spring Cloud Gateway 的优势
3. 快速入门
    3.1 环境配置
    3.2 创建Spring Cloud Gateway项目
    3.3 配置路由规则
    3.4 运行和测试
4. 路由配置
    4.1 URI路由
    4.2 断言路由
    4.3 过滤器
5. 高级特性
    5.1 熔断器
    5.2 限流
    5.3 日志和监控
6. 部署和管理
    6.1 部署选项
    6.2 容器化部署
    6.3 管理和监控
7. 故障排除
    7.1 常见问题
    7.2 日志分析
8. 总结和参考资料
    8.1 总结
    8.2 参考资料

读书

健身

我跑过了一些地方，希望随着时间推移，地图点亮的地方越来越多。2 年里我跑过 2 个省份 2 个城市。更多跑步数据在我的 跑步 主页。

理财

这周总计支出 5006 元，明细如下：

  • 7 月 16 日：4057 元，父亲出院支付 3475 元

  • 7 月 15 日：108 元

  • 7 月 14 日：86 元

  • 7 月 13 日：367 元

  • 7 月 12 日：179 元

  • 7 月 11 日：117 元

  • 7 月 10 日：92 元

陪家人

工作

最近在学习的内容清单：

本周完成一篇博客：

本周分享

大部分有意思的内容会分享在 『ChenSoul Share』Telegram 频道或者我的 Memos 中。我写了一个 Python 脚本从 Memos 读取最近一周带有 #memos 标签的记录，分享到这里。

以上。

Share this post:

Related content