刚入职被要求写这种文档，应该如何下手

Question

可能是为了让我更快的融入项目。让我完成这样的文档。
不太理解这种文档应该是按照什么去写。前端页面点一个功能写一个接口？还是按照项目代码里的接口去写
看了下文档库里之前没有这样的，问了下同事也没有做过这种的。求一个模板。

Answer 1

刚入职便被要求写这种文档，一般是老油条似的老员工不愿意做，然后任务没法接手，故而推给你。 入职第一件事是先熟悉项目概况，然后熟悉业务，再然后是熟悉代码，你连业务都不懂，上来就让你整理“衔接了那几块业务”，要么是检查你的工作能力，要么是没人接手这块才落到你这里。 正确的方式是先看需求文档，然后熟悉整个业务链这才是快速融入项目的便捷方式。

不太理解这种文档是按照什么去写

1、梳理需求文档，按照业务维度去分析，熟悉项目背景和目标。
2、找到代码，从接口到实现，依次分析，然后快速分析数据模块有哪些。
3、记录接口的业务逻辑、系统架构和使用的技术。
4、整理数据表，区分不同业务使用的表。
5、做后端的话仅概况到接口层面就好，无需写前端页面功能。

模板按照普通word写即可，设置好标题等级，按照一接口、二业务、三数据表、这几大类去写即可。里面的小类可以按照具体模块具体接口分别去整理。
若有帮助，记得采纳哦