活文档:与代码共同演进

[法]西里尔·马特雷尔(Cyrille Martraire)

出版时间

2021-02-22

ISBN

9787115553799

评分

★★★★★

标签

编程

书籍介绍

这是一本活文档参考指南,教你如何像写代码一样有趣地持续维护文档。

书中系统地阐述了计算机软件开发各个阶段中文档写作的步骤、内容、方法、工具、特点和要求,详尽指导软件开发人员和文档开发工程师写出规范的文档,包括软件文档的概念和内容,软件文档编写的原则和步骤,软件文档的管理和维护,可行性研究报告、软件需求报告、软件测试计划等文档的写作方法和写作技巧。

目录
第1章 重新思考文档  1
1.1 一则来自活文档世界的故事  1
1.1.1 为什么需要这个功能  1
1.1.2 明天你就不再需要这个草图了  2
1.1.3 抱歉,我们没有营销文档  2

显示全部
用户评论
没读完,目前来说有用的较少
google annotation gallery 稳定知识是一项可以长期回收的投资。 使用注解丰富知识,通过工具从代码生成文档,使用工具约束架构规范。
活文档主要是关于通过对话分享知识。谈了很多敏捷开发的思路和原则。整体可操作性不太够。
粗略翻了一下,主要关注其中一些思想性的东西,有一说一,很个人的角度来说,实用性不算很强,部分原则值得注意。
与我最近的思考比较相同,有一些参考价值。内容更多是思路,而不是具体方法。应用时需要根据自己上下文裁剪。另外,如果没有工具的话,很难落地。
挺有启发的。不过文字读起来膈应。
本书的价值在于强调了文档的重要性,在缺少文档的情况下,团队根本无法提高生产力。
这本书已经翻了个大概,但是仍然没有找到打动我的那部分;甚至我都没有get到书的整体脉络和架构。文档/知识传递应该是不错的主题,但是好像并没有讲好;或者译者传递有误,很多句子感觉很生硬
收藏