《3D编程模式》写书-第5次记录

大家好,这段时间我完成了对初稿的第一轮修改,即将开始第二轮的修改

这里是所有的的写书记录:
《3D编程模式》写书记录

本轮修改主要进行了下面的修改:

修改错误

修改了UML错误、文字错误、代码错误等错误

隐藏代码的实现细节,进行抽象

这一步修改的目的在于使案例中的代码只展示说明思路,隐藏实现细节

读者可以到代码库中去看实现的细节

具体的修改包括:

  • 删除部分的实现细节代码
  • 使用伪代码来替代部分的实现细节代码
  • 去掉与“运行”相关的配置等代码,将其放到代码库的说明文件中

明确使用“总-分”结构

每个章节、标题都使用“总-分”结构

统一格式、风格

因为7个模式的写作模板是一样的,所以它们的写作格式和写作风格也应该统一

圆润过渡语

加入一些过渡语,对文字进行斟酌

补充内容

  • 补充“扩展”、“具体案例”

  • 完成“遵循的设计原则”

  • 补充“更多资料推荐”

数据统计

经过本轮修改后,每个模式章节的中文字数大概增加了40%-60%,代码行数大概下降了10%-30%

参考资料

怎么样写出更好、也更简短的源码分析书

posted @ 2023-05-05 17:01  杨元超  阅读(43)  评论(0编辑  收藏  举报