官方文档往往是最权威、最全面的学习资源之一,了解和利用这些文档的结构与内容,可以大大加快学习进度和提升理解深度。
1、常见目录含义说明
Overview/Introduction(概览)
涉及多个方面的综述,类似文章开头的摘要
Products(产品列表)
Solutions(解决方案/使用场景)
Quick Start(官方提供的入门级引导)
官方的"hello world" Getting Started demo
Concepts(技术理念、概念、架构说明等)
Docs/Documentation/User Manual/User Guide/Reference
给不用角色(运维、管理员、应用开发)使用者的使用教程、运维指南、参考手册等
Reference
详细的参考手册,例如:
- API参考:详细的API文档,包括函数、方法、属性及其参数说明。
- 命令参考:列出所有支持的命令及其使用方式和选项。
Developer Guide(开发者指南)
给二次开发者提供的开发文档,作为仅使用者一般不用关心
FAQ(常见问题答疑)
Basic Usage(基本使用)
Advanced(高级指南)
Blog/News(官方博客/新闻)
官方发布的一些最新的消息通知等;往往可以从这里获取到一些优秀的文章;
Community(社区/生态)
Issues(问题反馈列表)
Features(产品核心功能)
Roadmap(产品演进路线)
Releases Notes/Changelog(已发布的版本列表)
版本历史:记录每个版本的更新内容、修复的问题和新功能。
Download(下载地址)
Installation/Setup(安装和配置)
Plugins/Extension(插件/扩展)
提供一些有用的插件,例如argocd的exec等都是以插件的形式;推荐和集成的第三方工具与插件等;
Tools/Utilities(实用工具)
提供一些有用的工具,例如:CLI工具:介绍命令行工具的使用方法和常用命令
Configuration(配置选项)
Benchmark(基准/性能测试)
就是类似厂商新手机跑分的东西
Support(技术支持等)
Academy/Courses(官方提供的学术课程)
Integrations(集成)
Glossary(术语表)
2、最佳实践
2.1、官方原文 + 机翻(google翻译)
- 虽然机翻一定不准,但是机翻能辅助做一些猜测;
- 先看机翻,能七七八八地看明白一些大概,一些机翻离谱的地方,再去看英文原文;
- 机翻+部分英文阅读看完一遍后,再重新用全英文方式阅读一遍;
2.2、常见的使用方式
API(API接口服务)
一般多为HTTP接口,本地代码集成时只需要引入一个HTTP客户端调用提供的原始HTTP接口或者引入官方的client sdk
Open Source/library(依赖库方式)
类似java maven安装jar类库、linux安装二方包依赖方式
No-Code Platform(白屏化产品化)
直接通过GUI方式使用,例如rocketmq控制台之类的白屏化界面
Docker Installation(docker镜像方式)
通过镜像方式运行,镜像里面都相关环境、依赖都安装好可直接使用,例如 unstructured docker-installation的使用方式