提升自己文档阅读能力的计划

起因

最近接的由于需要在Shiro的基础上搭建单点登录(SSO),选择了传闻集成非常简单的CAS来进行实现。
在Spring上集成Shiro和CAS的中文博客非常的多,但是大部分针对的是4.0.x版本的CAS,而官方的稳定版已经出到5.0.x了。再加上中文博客大部分都并不那么细致,跟着文中的步骤去实现也未必可以成功(包括我自己写的……),到头来还是要查阅官方文档,所以决定直接阅读官方文档来进行集成。

过程

这是一段虐心的经历。

首先找到CAS的GitHub地址,里面写道:

It is recommended to build and deploy CAS locally using the WAR Overlay method. This approach does not require the adopter to explicitly download any version of CAS, but rather utilizes the overlay mechanism to combine CAS original artifacts and local customizations to further ease future upgrades and maintenance.
Note: Do NOT clone or download the CAS codebase directly. That is ONLY required if you wish to contribute to the development of the project. Utilize the WAR Overlay method instead to build and deploy your CAS instance.

简单翻译一下
我们推荐您使用WAR Overlay method的方式来部署CAS,这个方法有blabla各种便利和优点。
注意!不要将整份代码clone到本地,除非你要来参与这个项目!

于是我兴高采烈得跟随链接来到了CAS 5.0.x的官方文档,然而上面写着这么一行大字

WORKERS AHEAD!You are viewing the development documentation for the CAS server. The functionality presented here is not officially released yet and may be unstable. This is a work in progress and will be continually updated as development moves forward. To view the documentation for a specific CAS server release, please choose an appropriate version. The release schedule is also available here.

简单翻译一下
施主留步!下面介绍的部署方法并非官方发行的正式版本,可能会不太稳定。

提升自己文档阅读能力的计划_第1张图片

同时,如果直接在Google上搜索"CAS JDBC"这样的关键字,会找到旧版文档地址。初来乍到的我并不之情,还在为什么会有两个官方文档的问题上纠结了一段时间。
另外,新版官方5.0.x的文档也并不是那么友好,在详细的介绍过安装方式和基本结构之后,所有的配置属性就一堆挤在一个页面,并且多数的配置属性都没有相关的介绍,完全不知道应该在上面填写对应的什么值(虽然这些属性的名称都非常直白,然并卵)。

反思

吐槽一时爽,但终究还是要总结一下如何在阅读文档上提高效率。
其实一直以来我阅读的速度就非常的慢,所以以前也总结过几点阅读文档的注意事项。简单来说就是有靠谱的中文先看中文,理解了大致流程之后再去官方文档查阅细节。然而这次却找不到特别靠谱的中文博客,并且官方文档也较为混乱,只能生啃原文。
虽然也通过Google的站内搜索功能(site)提高了一些效率,但是最最重要的还是提升自己的英语阅读能力。想到做毕业设计的外文翻译的那段时间,个人的英语阅读能力差不多达到了人生中巅峰,因而作出如下决定:

每周至少翻译一篇和技术相关的英文文章,并做好记录

目前暂定会找InfoQ上的文章原文作为翻译素材,毕竟翻译完成之后也可以有个对照。

愿与各位共勉

你可能感兴趣的:(提升自己文档阅读能力的计划)