编写优秀的编程文档:一份教学指南
本文作者以生动的比喻和故事,阐述了编写高质量技术文档的理念。他认为文档的核心是“教学”,而非简单地提供信息。文章批判了仅依赖源码、测试或代码文档化工具的不足,强调应将文档视为一个循序渐进的学习过程,从初次接触、快速上手到深入学习,最终到高级参考,每个阶段都应精心设计,引导用户成为专家。作者还分享了个人教学经验,并建议将文档编写视为教学过程,注重用户体验和知识的循序渐进。
阅读更多
本文作者以生动的比喻和故事,阐述了编写高质量技术文档的理念。他认为文档的核心是“教学”,而非简单地提供信息。文章批判了仅依赖源码、测试或代码文档化工具的不足,强调应将文档视为一个循序渐进的学习过程,从初次接触、快速上手到深入学习,最终到高级参考,每个阶段都应精心设计,引导用户成为专家。作者还分享了个人教学经验,并建议将文档编写视为教学过程,注重用户体验和知识的循序渐进。
阅读更多
本文讲述了作者在使用 Common Lisp 的元对象协议 (MOP) 开发库时遇到的依赖管理难题。作者通过一个监控类(monitored-class)的例子,展示了如何在子类继承父类的监控功能时,巧妙地利用 CLOS 的 Dependent Maintenance Protocol 解决因父类重新定义而导致子类监控功能失效的问题。文章详细解释了如何使用依赖包装器和更新依赖方法,确保子类始终继承最新的监控功能,即使父类被重新定义。这是一个关于在 Common Lisp 中进行高效交互式开发的实践案例,体现了 Common Lisp 强大的元编程能力和对交互式开发的良好支持。
阅读更多
这篇文章介绍了 Common Lisp 的历史背景、特点以及学习路径。Common Lisp 是一种历史悠久、功能强大、可扩展性强的编程语言,拥有稳定的核心语言和丰富的库。学习 Common Lisp 可以从《Common Lisp: A Gentle Introduction to Symbolic Computation》和《Practical Common Lisp》这两本书籍开始,并逐步深入学习宏、面向对象编程、低级编程等方面。文章还介绍了 Common Lisp 的生态系统,包括包管理器、常用库等。
阅读更多