注意: 站点右上角可以切换语言,部分文章也许有中英文双版
掌握一项技术需要读的几种类型文档
教程(Tutorials)
教程:针对单个知识点时这类文档往往是最优的学习材料,相反的缺点在于往往为了讲透一个知识点,细节太多,宏观较少。 这类文档适合需要实际演练一个知识点的读者,不适合已经熟练或者关注架构的读者。
快速开始(Quick Start)
快速开始:首次接触一个开源技术的首选资料,并不能帮你全面的了解描述对象。但是足够对描述对象的核心功能、基础依赖环境有个大概了解。
参考手册(Reference)
参考手册:是开源项目介绍的集大成者,是高手必须通读的文档,但是也会重点不突出,有些没有可以操作的实例(有些完全就属于字典类用于长期查阅的资料),新人看英文原版比较吃力。
用户指南(User Guide)
用户指南:通常是最适合开发者学习的资料,编写者会遵循学习使用的过程,由浅入深来展开内容,基本可以说有了User Guide就不要再买教学类的书了。个人理想的翻译辅助工具(CAT)的需求:
- 抽取出大纲,建立方便的导航,好的技术文档作者都会建立深思熟虑的大纲结构,利用好这些大纲,帮助读者、译者快速梳理信息。
- 使用分词算法,去掉翻译时不必的要鼠标选中操作,用鼠标去定位前后位置,实在是浪费了很多时间。
- 使用分段算法,使中英文始终能在意义段落和句子上保持对齐,方便中英文同时阅读。
- 使用机器翻译。在非专业术语上用机器翻译,可以帮我们快速跳过作者的“闲言”。
- 任何格式和技术社区的文档,希望能逐步建立一致的翻译和阅读体验
- 建立机器翻译的词库,进行自动翻译
- 一些额外信息统计当前工作进度和快速定位到感兴趣的工作内容
- 实现持续集成的工具链,翻译完能直接看到结果
现在我在用自己写的Gradle插件和Intellij插件,结合XML技术在做这些事情,还很原始简陋。理想中要是自己可以自定义一个编辑器比如基于VIM、VSCode就会很开心了,所以以上相关的备选技术都会一直关注以下。
关于个人博客
这个博客是用 Hugo 构建的,里面主要放一些 零碎的文章和一些翻译日志。
觉得好玩可以加微信交朋友,欢迎向我介绍有趣的东西。
再放上我和孩子的B站空间吧