需求
在我不少的开发生涯中,对于用户文档这一块,实际中会认真去阅读使用手册的用户是非常非常少的,所以最佳的操作文档应该是遇到不懂的输入项可以直接查看说明,如下图:
目前贴代码中关于这一块已经实现的项目有PasteSpider,如上图的点击后会跳转到贴代码官网的文档区块中
一个字段的说明,往往有至少前面2个层级,一个是项目,然后就是模块!
比如给商城的商品中的字段封面图编写这个字段的说明!
为什么要有PasteDocument项目
之前在刚使用PasteForm框架改造PasteSpider项目的时候,把PasteMark的特性(书签,字段文档)写入到贴代码官网了,随着后续的项目改版,PasteTask任务调度器,PasteTalk在线客服,PasteShop贴代码商城后发觉有这么一个需求,迫切需要一个项目可以用于囊括所有项目的字段文档!
如果要把这个PasteDocument给大家使用,或者大家可以自己部署一个PasteDocument,则有以下需求
1.不同项目之间隔离,比如商城的文档不能串门到客服系统中去
3.可以配置公开,或者授权用户才能访问,有些文档需要内部,有些则可以公开
4.需要支持邀约查阅,支持邀约注册,支持申请查看等,主要是针对需要授权才能查看的,主要是为了连贯
5.组织团队隔离,比如A公司,拥有多个项目,B公司拥有多个项目,都接入到贴代码文档来,所以有组织企业的概念
6.编辑上需要支持灵活配置,而不是需要去客户端新建,开发可以大胆的在需要说明的字段标注PasteMark特性,最后实现函数global_tap_mark跳转到贴代码文档即可,跳转过去后,支持快捷创建对应的文档或者板块等!
7.PasteDocument需要足够灵活,支持一键部署(docker/podman),支持PasteSpider部署等
解决方案思路
基于PasteForm框架进行开发,后续将进行文章直播和视频的方式,介绍或者说记录这个项目的完整开发过程,包括如何设计的,如何实现的,解决的思路和步骤等
下期见