如果项目刚结束、你手里只有一个交付压缩包和零散的聊天记录,最稳妥的粒度是“可独立复现当前线上状态”:保留能说明域名解析、服务器环境、程序版本、数据库结构、页面模板与关键配置的那一层文档,而不是把所有中间稿和每日截图都留下。判断标准不是文档数量,而是换一个人接手时,能否在不问原开发者的情况下完成一次小改动或一次恢复。
不要先整理整个项目,先挑一个线上页面,例如首页或产品列表页。把它从浏览器到源文件逐层拆开:这个页面由哪个模板渲染、模板里哪些内容是后台配置、哪些是写死在代码里、图片存在本地还是对象存储。把这条链路写成几行说明,如果写不出来,说明当前文档粒度偏粗。
接着做一次最小验证:假设这个页面上的联系电话需要更换,按现有文档能否找到修改位置并说明发布方式。如果只能靠登录服务器翻文件,文档就需要补到“文件路径加修改方法”这一层;如果后台就能改,文档只需记录后台入口、字段名称和权限归属。动作的结果直接决定下一步:能改,就按这个粒度处理其余同类页面;不能改,就先补环境与部署说明,再谈其他。
对多数中小型站点,历史文档保留到以下四类即可支撑后续维护:
可以舍弃的是:设计源文件的多个中间版本、已被替换的旧图片、每日沟通截图、与本项目无关的参考站素材。前提是最终版设计稿和上线素材已经单独归档。舍弃不是删除,而是移出主交付包,避免接手人把过期文件当成现行版本。
常见情况是项目结束后只拿到一个压缩包,服务器和域名账号仍在对方手里。这时不要等权限齐全再整理,先做三件事:
完成后的结果会影响下一步:如果压缩包里没有数据库文件,那么页面文字可能还在、但后台数据无法还原,文档粒度就要往“静态页面备份加内容重录方案”调整;如果配置文件里含有密钥,应先更换密钥再归档,而不是原样保存。
网站能正常打开、压缩包体积很大、对方回复“都给你了”,这些都不能单独说明文档够用。网站能打开可能只是服务器还在运行;压缩包大可能主要是图片和依赖包;口头确认没有可核对的清单。反过来,请求量下降或某个统计归零,也可能来自统计代码未加载、访问路径变化或采集口径调整,不能直接推断为文档缺失或交接失败。
更可靠的证据是:按文档操作一次备份恢复或一次页面文案修改,看是否成功。这个测试只针对你实际拥有的权限,缺权限时只能验证到“能读懂”,不能验证到“能执行”,这一点要在交接记录里写清楚。
假设一个站点的首页需要三年后改版,接手人拿到文档后应能回答:模板文件在哪里、样式文件在哪里、图片上传到哪个目录、改完如何发布、出错如何回退。只要这五个问题都有明确答案,文档粒度就基本够用;如果只能回答其中两三个,就按缺失项补,而不是整体重写。
最后给文档定一个复核时间点,例如每半年核对一次账号归属和备份可用性,并在变更记录里写下核对结果。粒度合适的历史文档不是越厚越好,而是让下一个动手的人少问几个问题、少走一次弯路。