在一个创业公司从零开始写程序一年多了，现在老板提出要文档化，要让新来的人也能快速上手项目，我不知道应该写哪些东西到文档里，可能写进去的过段时间后代码就被别的同事改了，文档就不对了，我要不要写文档，写什么，或者有更好的方式？
Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号
6
552
收藏
在程序猿的世界里，代码化是一种最佳实践，所以文档也需要代码化，因为不代码化的文档就是刻舟求剑，可能今天的文档明天就过期了。
而业内主流的文档代码化就是单元测试代码，TDD已经给出了解决方案。
以上。
代码修改记录
数据库修改记录
出现的问题，解决的办法
同事修改的话，要让同事更新到文档内容醉后面，别直接替换
我觉得首先交代一下公司项目的基本流程和规范比较好，比如新来的可能不一定知道公司之前的一些工作记录，搞不好做了重复工作和瞎折腾。可以先简单说明一下公司项目中用到的一些工具，框架，平台的基本介绍和相关链接；然后是公司编码规范，基本业务，工作计划(Todo)，代码管理；然后是之前在工作过程中遇到的一些问题和解决方案，避免新人继续入坑；最后可以给新手推荐一下公司业务可能涉及需要去学习了解的技术栈。
php开源的DokuWiki
这本来就是一个坑，开发的时候没写现在写。
不过可以给些参考：
系统设计文档、数据库设计文档、接口设计文档、网站布署配置文档、网站使用说明文档等
我觉得前期不要采用其他方式进行文档管理，所有的文档直接跟着项目走，严格执行代码注释，然后通过phpDocumentor自动生成文档。只要代码中的注释有跟着代码修改进行更新，则文档就会保持更新