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

img

img

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

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

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

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

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

这个是没有具体的模板格式的,主要还是思路清晰,架构明了,建议可以不用做全,针对其中一个小模块,先举个示例,然后截图发个领导看看,评点指导一下,然后在按照这个思路走下去。可参考如下图:

img

怎么写要看它到底给谁看
内部使用有内部使用的写法
申请软著有申请软著的格式
如果是用户手册,可以尽量花里花哨一些,反正他们也看不懂
你还是应该先问问应用场景

用最近爆火的人工智能写,可以中文提问https://so.csdn.net/so/chat

哈哈 接手他人的项目第一件事是要文档,自己的项目永远不自己写文档。
新人写这个也没啥坏处 就当熟悉下业务,也可以帮助你了解项目实现的代码逻辑细节 方便日后上手
如果内部没有强制要求啥格式就自己 找个通用项目文档的模板 简单写一下接口用途这些就行了,然后用pdman 导出一个数据库结构信息备注下字段信息也就得了,大概率也没人看的

你可以再具体问问看要求

天下文章一大抄,看看前辈写的。你就有思路了

以下答案引用自GPT-3大模型,请合理使用:
我也不知道呢🤔