服务内容全部包含:
适合这几种情况:项目要交接给新人或新团队;外包结束后需要内部接手;准备重构之前,想先摸清老系统的结构。
我们对代码仓库做本地静态分析,再加上人工阅读源码,产出一份中文交接说明书,帮接手的人更快建立对代码的整体认识。
进阶版 ¥499
- 包含基础版的全部内容
- 新人上手手册:阅读顺序、本地运行步骤梳理、常见改动的入口
- 交付后 7 天内,通过平台消息文字答疑,累计 1 小时
服务优势:
基础版 ¥199
1. 模块级依赖图(PNG)和可以交互搜索的图谱文件(用浏览器打开)
2. 中文模块说明表:职责、行数、依赖关系、改动风险点
3. 核心类/函数和主调用链路说明
4. 10 个常见问题(FAQ)
5. 文档格式:Markdown + PDF
服务前需客户提供的信息:
只接需求方本人拥有的仓库,或者已经获得所有者书面授权的仓库;下单前需要确认授权情况,可以签保密约定
代码只在本地处理,不公开、不留作他用,验收后可以按要求删除
其他:
不包含代码修改、功能开发和安全测试,这些需求可以另行沟通
所有沟通和交付都通过平台订单与消息进行
文档基于交付时那一版代码,作为理解代码的参考资料,不对后续开发结果做承诺
对一个公开开源项目(Python 网络请求库,Apache-2.0 许可,约 6,400 行)做的样例:依赖图、19 个文件的中文说明和 10 个常见问题,见作品图。