Tech
[分享创造] den:终极文档维护方案
https://github.com/onichandame/den
我被项目文档维护恶心到极点了,于是返回第一性原理思考文档的本质。它是项目的长期事实记录,需要能被很快地消化吸收。
现有方法论多数是规范化文档治理方法,通过统一心智模型来加速文档的吸收速度。但并没有一个适配所有场景的标准方法论,即使是大厂也经常出现文档过时或内部有多套方法论的情况。
从输入端不好解决,输出端能否解决呢?我马上想到如果可以通过语义搜索项目文档里我需要的内容,那完全没必要死磕文档维护方法了,全部平铺在 docs/下都可以,需要查文档的时候搜索就好嘛。
den 的主要场景就是这个:快速搜索项目内文档。搞完这个心情也舒畅很多
Read the full discussion on V2EX
This article was aggregated from V2EX. Click to join the conversation.
View on V2EX