作者：UOrb
声明：文章为稀土技能社区首发签约文章，14天内制止转载，14天后未获授权制止转载，侵权必究！
前语
尽管许多描述看起来比较 “主观” 哈，可是这是为了投合 文章 方式，正常来说需求文档要以 “客观真实” 的方式来进行书写才是。
项目背景
勉强算是爱好使然吧，之前做 wangEditor 的时分，略微对 富文本修正器 有少许了解，也从前规划过相似平台的计划，仅仅终究没有实施出来。
然后 wangEditor 做第五版别的重构的时分，由于作业上的原因导致脱节了，也就没有继续参加的开发了。
接着又由于一些原因，现在的事务时刻上相对来说比较宽余，可是 wangEditor 第五版别现已做的差不多了，也就没有必要再参加进去了，所以就想着有没有其他的东西能够做，就想到了之前规划的 平台 和之前比较感爱好的 协同算法，终究就有了想做一个 在线文档 的主意。
签约作者计划的签约作者需求针对某个方向（专栏）写一系列的文章，正好能够和上述的主意交融在一起，所以就有了 手把手从零到一打造在线文档 专栏了。
项目价值
一般来说，大部分在公司的作业都和 事务场景 脱离不了关系，而然正常来说仅仅仅仅做事务是容易抵达瓶颈的，出去找作业也很难有多高的 竞争力，所以需求有一个别的的途径让自己更 专心 于技能或许某个领域，在进步自己的技能能力之外，一起在找相对应的作业时也更有 竞争力。
由自己来从零到一来界说一个项目需求阅历 需求搜集 - 需求调研 -> 需求分析 -> 需求评审 -> 技能调研 -> 技能计划设计 -> 前端开发 -> 后端开发 -> 项目部署 -> 运维 -> 迭代 等进程，一般来说依据各自 岗位和职责 的不同会分属到整个流程中的某个部分，很少会有人能 贯穿始末，可是这儿就需求自己一个人负责和处理一切阶段的内容，从一而终 贯穿始末，这能够让自己愈加了解到一个项目 完好 的生命周期，能够对自己作业中的 定位 愈加清晰。
一起也能够收获一个符合自己习气和预期（依据自己的习气、需求和主意来完结在线文档，不用一定文章一毛一样的）的在线文档，甚至能够引入到公司中，作为公司内部专属的在线文档和知识库，给自己的晋升和年终奖打下基础（狗头保命）。
竞品调研
正儿八经的竞品调研阶段的案牍，会很严谨，而且会有具体的阐明以及对比后的优缺点。
一般来说想要确认一个 清晰的需求 是需求做相对应的 需求调研 的，我本人也 没有 正儿八经的体系学过也 没有 该方面的具体经历，所以这儿仅仅趋于我使用过的在线文档，例如：语雀、腾讯文档、飞书文档 等，再结合本身的 体验 来决定我自己要做的 在线文档 具有哪些功用以及方式。
调研之语雀
我个人用的最多的在线文档应该便是 语雀 了，首要我最喜爱的或许便是 知识库 的面板功用了，尽管转换过来便是 文件夹 + 文件列表展现 的能力，可是能够很好的对文件进行分类和办理，比直接的文件夹看起来会更清晰，至少关于我来说 语雀 的 知识库 给我的体感很好。
可是语雀 空间 + 团队 + 知识库 + 更新 的链路着实有些长，操作起来着实有些繁琐，特别是 更新 的操作那是又爱又恨，爱是由于修正后的文档不是实时更新的，能够调整好后再进行更新，恨是由于常常修正完结后忘掉点更新按钮进行更新。
调研之飞书文档和腾讯文档
飞书文档和腾讯文档的方式 根本相似，市面上大部分的 在线文档 也都是这种方式，相似于 Office、WPS 等工作软件。
我 个人 其实是不太喜爱或许习惯这种方式，由于在 电脑 上一般是经过电脑的 文件资源办理器 来对文件进行 分门别类 和 办理 的，事实上关于大部分人来说想要修正某个文档第一步是经过 文件资源办理 来找到该文档文件，而不是经过翻开 客户端 在 客户端 的 记载 里面查找。
可是这类文档的 链路 相对来说就比较短了，一般来说都是同首页的最近或许查找 查找 某一个文件，当然它们也能创立文件夹什么的，可是 UI 视图都是列表，而且无法创立单独的空间出来，所以不那么 直观，相对来说操作也会更 便捷和简练 一些。
调研定论
总的来说各大在线文档都有自己的 优势和劣势，它们的 倾向 各不相同，所以也没有什么高低之分，用户只需求依据本身的具体状况和 需求 来挑选最符合自己预期的就好。
那么关于我来说，首要我需求能创立 独立的空间 而且需求更好的文档 分类和办理（强迫症？） 的能力，所以我计划参考语雀的 空间 + 团队 + 知识库 的方式，可是语雀的 空间 关于我来说许多余，而且会拉长全体的途径让操作的 过于繁琐，而且语雀的团队现已能 满足 我的创立独立空间的需求，所以略微调整一下，我只需求 独立空间 + 知识库 的途径。
别的关于保存是 手动更新 仍是 主动更新 这件事儿吧，我仍是比较拿捏不准的，主动保存十分方便，可是有时分没写完或许试验性的写作就不太想让它直接展现出去，手动保存的可控性十分的强，能够自己操控是否要把当时更新进行展现，尽管能够考虑一下给每个文档增加一个装备，是否主动保存的选项，勾选了则会主动保存，不然需求手动保存，但实际上也是延长了整个操作链路有点多此一举的感觉，由于初期是 个人项目 没有太多的展现担负，所以先决定使用 主动更新 的计划。
功用需求
在线文档的 中心难点 在于 富文本修正、协同算法 等方面内容，其他也仅仅正常的事务范围，富文本修正其实能够在 Github 上找到许多优秀的开源项目，协同算法 这个不是初期考虑的工作，是后期迭代中重要的功用。
功用结构
登陆和注册
登陆和注册就没啥可说的了，根本都那样，原型图这咱这也 设计 不出啥美观的 UI 不是。
登陆和注册成功后主动跳转至 个人中心 页面
用户名最短六位数，最长不能超过二十六位数，必须由字母开头，不能含特别字符；
暗码最短六位数，最长不能超过二十六位数，不能含特别字符。
个人中心
个人中心归于在线文档的 主要页面 了，大部分状况下使用在线文档 第一步 都是会进入到个人中心页面，然后经过个人中心页面再来 流转到 其他的功用页面或许文档之中，所以个人中心直接就对标着 用户体验度 的好坏了。
知识库面板
一个空间下面能够创立若干个知识库，一个知识库下面能够创立若干文档，文档必定有一个所属的知识库，知识库必定有一个所属的空间。
经过个人中心上方的 header 中的 操作栏目 中的 新增空间 按钮，能够唤出新增空间弹框，新增空间弹框中需求填写 空间称号 和 简介 两项数据，当然也能够依据 需求 来设置更多的项进行填写和装备。
修正空间则经过 面板 中的 标签页 切换到设置中进行更新。
创立空间需求填写空间称号和空间简介，其间空间称号是必填且不能有特别字符。
新增知识库则需求在知识库面板的 功用按钮 中点击新增按钮，引发新增知识库弹窗，弹窗中需求填写知识库的 称号 和 简介，而且需求挑选新增到的空间，默认挑选当时空间
已有知识库的信息变更则能够在对应知识库卡片上的 操作下拉菜单 中引发修正弹框，也能够在知识库概况中引发修正弹框。
创立知识库需求填写知识库称号、知识库简介以及所属空间，其间知识库称号和所属空间是必填且不能有特别字符。
一起知识库面板能够经过操作下拉菜单对自己进行重命名、删去等操作。
知识库目录
点击知识库面板的知识库称号，就会进入到知识库目录，会经过列表的方式展现该目录下的一切文档，而且能够经过操作下拉菜单对文档进行翻开、删去、装备变更等操作；一起也能够在目录中创立新的文档。
最近阅览
阅览记载能够帮助使用者快速的 回顾 最近阅览的文档，能够在某种程度上快速找到 目标文档 ，减少操作途径，阅览记载也是以 文档列表 的方式展现，经过 拜访时刻 进行倒序排列。
阅览记载的 文档列表 和 知识库文档列表 的方式相近，可是无法对文档进行修正装备、删去等操作，只能翻开该文档，阅览记载中也无法创立新的文档。
阅览记载中能够经过查找功用快速查询指定文档。
回收站
回收站是用户近期删去的文档集合，也是以 文档列表 的方式展现，回收站内的文档无法进行查看、更新、修正装备等操作，只能对其进行操作栏目的 康复、直接删去 的操作，康复会将该文档的删去取消，文档将会回到原始的知识库中，直接删去则是将文档彻底的删去了，再也找不回来了。
回收站中能够经过查找功用快速查询指定文档。
结尾
其实本文的需求阐明，仍是十分的 粗糙，正常来说 需求文档 会在功用阐明的时分顺便上原型上展现内容的 字段阐明 、操作阐明、字段阐明、数据来源、状况判定关系 等等。
然后这究竟归于 个人项目 ，一切的一切 “自己” 进行把控，所以 需求 相对来说粗糙了许多，由于许多东西 “自己” 能够 挑选性 的把控，可是在公司的项目傍边，由于是 多人、跨团队 的协作开发，所以需求 越具体、越清晰 就越好，一起在你阅览或许书写技能计划设计的时分，发现需求有不清楚或许不合理的时分，就要 及时 的去反馈和咨询，尽早和尽或许的把 前端、后端、产品 三方对需求的理解 对齐，不然放任不管到最后或许会导致各种各样的 问题，例如：反复横跳、计划重做、项目延期 等状况。
一个好的需求文档，能让项目开发少走许多 弯路，能让 前端、后端、设计 在内的一切项目参加人员对自己要做的需求有一个 清晰的画像，能更快更好的完结需求内容。
最后总结一句：无他，唯胸中有数尔。
