【Cocoon T2】WeaveX 织文诞生记

Cocoon 2024-03-30 16:51:59

选题调研和需求分析

项目	内容
这个作业属于那个课程	软件工程
这个作业的要求在哪里	第二次团队作业
我在这个课程的目标是	获得软件工程方面的知识，提高自己的编程能力，团队协作能力。开发一款令自己满意的软件。
这个作业在哪个具体方面帮助我实现目标	完成选题调研和需求分析，为后续的工作做准备

选题描述

产品名：WeaveX (中文名：织文)
logo：
- 还没出生，用整活的WeaveX占位，敬请期待！
产品描述：Cocoon团队的丝茧还是落到了LaTeX编辑器上，所以我们给它起名为WeaveX(/wiːveks/)，有用Cocoon的丝茧Weave Tex（编织文本）之意。所以中文名为“织文”，文字简洁而富有表现力，给人以编制文字的联想，符合编辑和协作的概念。希望它能够给你的LaTeX编辑带来更好的体验。
平台：首先满足web端的开发，其次考虑windows开发

选题背景与调研

竞品分析

经过分析，我们的主要竞品是与LaTeX相对的typst，以及现有的LaTeX编辑器Overleaf、VSCode、TexStudio等。

下面我们对这些竞品的优缺点进行了分析：
typst：
- 优点：
  - 更简洁的语法，没有各种冗长的宏（结构化的标记语言）
  - 更清晰易懂的报错
  - 实时增量渲染
  - 环境简单易配置、引擎体量小、编译速度快
  - 可编程排版，有更现代的脚本语言系统
  - 网页版支持多人协作编辑
  - 文档模版多、社区活跃
  - 潜在用户多
- 缺点
  - 网页版不支持自行部署（self-hosting）
  - 缺少原生绘图库（相比 Latex，使用代码控制生成矢量图等）
  - 断行、断页算法较弱（相比 Latex）
  - 小体量文档生成的 PDF 体积偏大（2 页纯文字文档编译体积为 2 MB，相比 Latex）
  - 知名度低、特定场景（学术论文等）下接受度低、直接用户较少（相比 Latex）
  - 对于已经会使用 Latex 的用户而言，切换成本比小白用户更高（尤其是 Latex 公式语法，与 typst 有一定差异）
Overleaf：
- 优点：
  - 提供在线编辑平台
  - 多人协作编辑
  - 环境简单易配置
  - 可自行部署（self-hosting）
  - 源码视图与预览视图可双向定位
- 缺点：
  - 官方平台网络访问不稳定
  - 编译与结果显示响应慢
  - 2 人以上协同编辑收费
  - 源码视图辨析度不高，内容与宏无明显差异，不直观
  - 数学公式输入无相关工具支持
vscode+工具链：
- 优点：
  - vscode用户群体更大，界面美观
  - 可配置性强
  - 实时编译渲染
  - 源码视图与预览视图可双向定位
- 缺点：
  - 需要本地安装 Latex 工具链
  - 配置编辑麻烦
  - 无协同编辑功能
还有一些工具并不常用，我们也进行了调研，以下是调研结果

产品	优点	缺点
TeXstudio	源码视图与预览视图可双向定位	源码高亮不美观、配置不友好、需本地 Latex 工具链、无协同编辑
vim/emacs/atom/sublime	可自定义程度高	配置复杂、用户少、需本地 Latex 工具链、无协同编辑
LyX	有预渲染支持	用户少、需本地 Latex 工具链、无协同编辑
WinEdt、TeXworks 等	-	界面老旧、用户少、需本地 Latex 工具链、无协同编辑

问卷调研结果

我们通过问卷调研了LaTeX的使用情况、竞品调研、用户需求等，以下是调研结果的总结：

问卷基本信息：
- 本项目发布的问卷调查共回收100份有效问卷，其中大部分被调查者为信息类专业（81%），还有小部分被调查者分布在理科类专业（7%）和非信息类工科专业（5%）。在所有的有效问卷中，67%的被调查者表示曾使用过LaTeX，其余未使用过LaTeX的被调查者中，也有60%的人曾听闻LaTeX。
- 综上，我们认为LaTeX使用使用范围广、潜在用户群体丰富，对高效LaTeX编辑器有较大需求
用户使用情况分析：我们调研了使用LaTeX的用户使用其完成的主要工作、初上手LaTeX遇到的障碍，和不使用LaTeX的用户不使用的原因。
- LaTeX完成的主要工作：绝大部分被调查者表示LaTeX的主要用途为论文撰写（81%），其余主要用途为实验报告（31%）、制作简历（25%）、制作slide（13%）和笔记整理（12%）等
- 初上手LaTeX遇到的障碍：半数以上的被调查者表示自己刚开始使用LaTeX时遇到的主要问题为找不到自己想要的模板，此外，界面调整（43%）、图片排版（36%）、宏包引入（34%）和数学公式编辑（30%）也是占比较大的困难所在
- 不使用LaTeX的原因：通过对未使用LaTeX的用户的进一步调查，其不使用LaTeX的主要原因有：缺乏使用机会（60%）、认为使用麻烦（45%）和Word等其他工具已能满足需求（30%）
竞品分析：我们调查了用户经常使用的LaTeX编辑器，并针对主流使用的LaTeX编辑器调查了其痛点问题。
- Overleaf（79%）：Overleaf用户反馈的痛点可以分为三个层次。
  - 主要痛点为：2人以上协同编辑要收费、编译调试比较困难、访问不稳定，这些问题被提及的频率均在35%以上；
  - 次要痛点为：默认源代码段落感不清晰、代码补全不是很好用、数学符号输入不方便、数学公式面板要收钱，大约20%的用户反馈了这些问题；
  - 一般痛点为：设置看不懂要干些什么、界面都是英文等
- VSCode+插件（43%）：半数以上VSCode+插件用户认为其setting不利好初学者（65%），此外还有环境配置困难（49%）、不能支持协同编辑（34%）、代码补全不是很好用（17%）等问题
- TexStudio（15%）：TexStudio的痛点分布比较平均，主要包括：代码补全不是很好用（50%）、UI界面看上去比较老（40%）、用户学习成本比较高（40%）、设置看不懂要干些什么（30%）和默认代码高亮不得劲（30%）
- 其他（10%）：TeXworks、WinEdt、LyX、ShareLaTeX和(Vim / Emacs / Atom / Sublime Text) + 插件等编辑平台的使用频率很低，均不超过5%。综合其统计结果可以得出这些软件的普遍问题为UI界面看上去比较老和代码补全不是很好用
用户需求：我们调研了用户经常使用的LaTeX辅助编辑工具和用户希望能使用的功能，将会在WeaveX中作以集成和开发
- LaTeX辅助编辑工具：用户主要使用的辅助工具为文献相关工具BibTex（31%）和数学公式辅助工具MathType（22%）和Mathpix（9%）
- 用户希望能使用的功能：用户主要希望WaveX具有的功能为：模板库（提供北航毕设模板等常用模板）、协同编辑、数学公式编辑器和Latex的预渲染等。

这些需求较大的功能将会成为我们开发的重点

产品特征

我们根据竞品分析和用户调研的结果，确定了我们的产品特征，按照实现难度和需求度分为基础功能和增量功能。

基础功能

模板社区
- 系统提供由经验丰富的LaTeX用户制作的模板，并鼓励广大用户贡献模板，通过审核机制构建一个多样化、高质量的模板宝库。
- 提供强大的搜索功能和标签系统，用户可通过关键词、分类、标签快速找到所需的模板。
协同编辑
- 协同编辑需要配置基本的版本管理功能，用于支持同步合并以及版本回退等操作。
- 利用实时通信和操作转换算法实现文档实时同步和合并。
- 实现细粒度的权限控制管理机制，确保用户只能对授权的文档进行编辑，保护文档的隐私和安全。
- 实现评论系统和实时通知机制，允许用户在特定位置添加注释和反馈，并通过系统提醒，促进团队间的沟通和协作。
LaTeX预渲染
- 在前端实现部分内容的预渲染，在用户编辑时提供即时的视觉反馈，如数学公式、源码高亮显示、宏包管理等
- 采用增量渲染的机制，仅重新渲染变更的部分，提高响应速度
- 关于预渲染的实现，很多功能我们可以基于已有的开源代码进行迭代，如KaTeX等。
- 然后我们也会考虑选择一些比较需要预渲染的内容，如数学公式、表格等，进行优化，并且最后预渲染的界面进行更多的优化（比方说，如果是未渲染的内容，至少我们会明显的分隔出来）。
数学公式辅助
- 提供直观的数学符号分类面板，方便用户轻松地查找预定义的数学符号和公示模板。
- 利用深度学习实现图像识别技术，支持将上传的数学公式图片转换为可编辑的LaTeX代码。

增量功能

git版本控制（升级版）
- 集成 Git 模块
- 提供 GUI 界面，简化操作
- 便于用户进行协作、分支管理、备份和恢复。
AI 辅助
- 接入 AI 接口
- 减少编写重复代码的次数，提高书写效率。
md 转 LaTeX
- 快速将 markdown 文本转换成 latex 文本
- 便于将平时笔记内容转变为较正式的记录。
直接调用板子代码
- 在编辑时提供接口，可以直接提供板子代码
- 优化用户书写体验，减少找板子带来的时间浪费
部署北航内网
- 连接流畅稳定
- 方便学生们登录访问使用

产品分析

其实不少NABCD的分析已经融入到我们前面的调研中了，这里再做一次总结。

Need：
- LaTeX 作为一种广泛使用的文档准备系统，被广泛应用于论文撰写、简历制作、实验报告、笔记整理等各个方面。其优势在于排版精美、灵活的数学公式编辑功能，丰富的模板等特点，深受研究人员和学生的喜爱。但当前市面上的 LaTeX 编辑软件都或多或少存在一些痛点，如 Overleaf 的收费，网络不稳定；vscode 的环境配置困难；TeXstudio 的界面古老，上手难度高。
- 在与北航信息办的交流中，我们了解到北航的师生对 LaTeX 有极大的使用需求。因此在与信息办的合作下，我们决定开发一款更适合“北航体质”的 LaTeX 的编辑器。该编辑器致力于解决以上提到各种痛点，并根据北航师生的使用需求进行开发。
Approach：
- 考虑到多端协同，我们会优先考虑web端的开发。我们将采用前后端分离的开发模式。并在后端部署LaTeX引擎与预渲染引擎，并对其进行定制化，以提高渲染速度。
- 在开发该软件时，我们采取了两步策略以确保我们的产品能够满足市场需求且具备竞争力。
  - 首先，我们对市场上现有的 LaTeX 编辑器进行了全面调研。这一过程不仅帮助我们了解了现有产品的功能和用户界面，而且还让我们能够识别出这些产品中存在的通病和用户不满意的地方。通过这种方式，我们可以避免重复开发已经存在的功能，同时还能确保我们的产品在功能和用户体验上有所创新。
  - 其次，我们特别关注了用户的实际需求和遇到的问题。通过对北航师生进行问卷调查，我们深入了解了他们在使用 LaTeX 编辑器时遇到的具体痛点。这些宝贵的第一手数据不仅为我们提供了改进产品的方向，也使我们能够设计出更加符合用户需求的功能。
- 我们根据竞品调研和问卷调查的结果，确定了我们的产品特征（功能实现的优先级），区分了基础功能和增量功能。
- 我们将在alpha版本中尽量完成所有的基础功能，在Beta版本中加入增量功能以及对于基础功能的体验进行优化。
Benefit：
- 稳定高速：面向北航全体师生，服务器部署在校内，稳定连接，高速访问。
- 多样模板：有着良好的模板社区生态，分享、使用丰富的模板。
- 协同编辑：更稳定、更多人数的协同编辑，真正的强协同性。
- 简单易用：数学公式识别，数学公式输入，颠覆过去手打数学公式的窘境。
- 光速预渲：一边编辑一遍查看效果，宛如Markdown的使用体验。
Competition：
- 现有的LaTeX客户端存在如下问题：
  1. 渲染较慢、不支持预渲染
  2. 学习成本高、较难入门
  3. 不支持协同编辑
  4. 模板较少
- 现有的LaTeX平台存在如下问题：
  1. 连接不稳定，时常掉线影响体验。
  2. 模板收费，可用模板少。
  3. 协同编辑收费、不稳定。
  4. 数学公式输入复杂
  5. 补全不完善
Delivery：
- 在冯如杯及毕设的大背景下，有许多论文编辑需求，有很多潜在的用户。
- 另外我们将把LaTeX编辑变得简单易用，可以让大家尝试日常编辑记录。
- 由于这也是信息办的一个开发需求，我们可以通过计算机学院、北航信息办的官方渠道等进行推广。
- 通过微信群的方式建立用户群体，收集用户反馈，不断迭代。
- 预计Alpha版本的内测用户量会在100以上200以下，保证在用户高度活跃的同时能够测试到产品稳定性的问题。并且Alpha版本可能不会联系信息办部署，所以硬件资源不能有太大压力。
- Beta版本的内测用户量会在200以上500以下，Beta版本会尝试联系部署至信息办，加大测试的压力与规模。
- 预计发布一周之后的总用户量能够达到500，刚上线的时候日活跃用户可能会比较多，所以要保证服务器的稳定性。但是平常的日活跃用户量并不会很多。