技术文档一式两份是不是比较好

[flamiNNgo]

一份自己看，规整、详细、啥都有
一份公布用，主要是应付文档要求、同时隐藏一部分细节
自己写可以不用那么规范，同时自己写的，看到细节能知道是什么
提升替换成本？

[rongpx95]

有些麻烦，我在想，都详细点会有什么问题？

[israinbow]

公布用的隐藏细节用注解不就行了, 整两份给自己加工作量和心智负担何苦呢.

[pkoukk]

文档最常见的问题是经常跟不上代码的版本（ hotfix 或者小更新，不总是会立刻更新文档），写两份文档更是会扩大这种问题
你说的那些细节，也没必要非要放到文档里，找起来改起来也不是特别方便，如果只是给自己看的话，我一般会写在更新日志/发布日志里
提醒一下自己找回记忆

[zhenghuiy]

空想的时候当然啥都行，但真正去做的时候，一定会受不了这个额外的工作量。

[KDr2]

这不是一式两份，这是两式。

[flamiNNgo]

@zhenghuiy 是的，hhhh
@KDr2 是的
@pkoukk 有道理
@israinbow 有道理
@rongpx95 主要是增加自己的替换成本

[israinbow]

@flamiNNgo #6 什么是 "自己的替换成本" ? 你是不是再找 "不可替代性" ? 那你不写不就完了🤔

[crazyTanuki]

感觉你这是在整自己,不是整别人

[DigitalG]

如果是自己选择工具记录，可以用能加注释的文档方案，公布用导出的 markdown 或者 pdf

[zexinwu84]

一式两份不是这个意思

[opengps]

带有公司资料的，干脆别发布，一不小心都是在给自己挖坑

[xiangyuecn]

放心，自己写的代码，别说别人，过段时间自己都不愿意去看🐶