php - 请教下你们团队中有文档吗？哪些内容是需要专门的文档来记录的？

问题描述

问 题

在一个创业公司从零开始写程序一年多了，现在老板提出要文档化，要让新来的人也能快速上手项目，我不知道应该写哪些东西到文档里，可能写进去的过段时间后代码就被别的同事改了，文档就不对了，我要不要写文档，写什么，或者有更好的方式？

解决方案

在程序猿的世界里，代码化是一种最佳实践，所以文档也需要代码化，因为不代码化的文档就是刻舟求剑，可能今天的文档明天就过期了。

而业内主流的文档代码化就是单元测试代码，TDD已经给出了解决方案。

以上。

这篇关于php - 请教下你们团队中有文档吗？哪些内容是需要专门的文档来记录的？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！