前端详细设计文档怎么写 前端详细设计文档怎么写的

Web前端UI设计方法

UI设计不一定需要精通前端，但是如果UI设计了解前端可以减少和开发人员沟通的技术成本，让团队协作更加高效。那UI设计如何学习前端，需要学习到什么程度呢？

前端详细设计文档怎么写 前端详细设计文档怎么写的

前端详细设计文档怎么写 前端详细设计文档怎么写的

我们分享一个前端教程-网页链接，这里面详细讲解了UI设计中的Web前端设计规则及工具，可以帮助大家深入理解Web前端UI设计方法。

1、HTLM基础认知DIV框架及CSS样式

首先要了解HTLM基础、CIV框架以及CSS样式， HTML称为超文本标记语言，是一种标识性的语言。它包括一系列标签．通过这些标签可以将网络上的文档格式统一，使分散的Internet资源连接为一个逻辑整体。DIV元素是用来为HTLM文档内大块的内容提供结构和背景的元素。 CSS不仅可以静态地修饰网页，还可以配合各种脚本语言动态地对网页各元素进行格式化。CSS 能够对网页中元素位置的排版进行像素级控制，支持几乎所有的字体字号样式，拥有对网页对象和模型样式编辑的能力。

2、浮动原理、Margin认知

Margin，是CSS的语法，这个简写属性用于在一个声明中设置所有当前或者指定元素所有外边距的宽度，或者设置各边上外边距的宽度。

3、框架应用搭建

框架很多，在这个教程中选择一个主流框架带大家看看前端框架如何搭建。

4、插入、文字标签和版头、导航栏

编写的网页中插入，可以使浏览网页的用户得到更好的体验效果。在这一部分会讲解插入、文字标签以及版头和导航栏如何实现。

5、Banner块插入、内容文字排版、内联元素、A标签和Banner链接定位

Banner是网络广告最早采用的形式，也是目前最常见的形式。它是横跨于网页上的矩形公告牌，当用户点击这些横幅的时候，通常可以链接到广告主的网页。而网页中的文字内容排版也直接影响着网页的美观以及网页的用户体验。

6、锚点标签、超链接标签、固定定位和定位、相对定位

标签用于定义超链接，用于从一张页面链接到另一张页面。用于设置锚点，用于页面定位。

7、导航二级菜单显示隐藏

很多网页中的二级菜单栏不直接显示，需要鼠标移动到一级菜单或者点击一级菜单才会展开显示二级菜单。

8、input表单

input表单可以获取用户的信息，做出对应的动作，教程中直观的展示input表单的应用方法。

其实以上教程只是web前端很小的一部分，UI设计如果能够了解前端知识，在设计中可以更好的考虑实现问题，也能够更好的和开发人员交流，也能够提高团队协作的效率，加速项目的进度。

如何写好项目方案设计文档

事实上，撰写项目规划和设计文档，最重要的不是文档的模版和格式，而是里面的具体内容，它往往需要结合实际客观环境因素来综合考虑，平衡取舍，是一个需要充分脑力活动的工作。尽管如此，在大多数情况下，还是有一些相对通用的指导原则可以帮助我们更好的完成这项工作。

首先，需要有明确项目背景，目标，以及核心需求分析

换句话说，就是这个项目从产品或业务的角度，最核心的推动力是什么？再换句话说，痛点是什么？

有痛点自然就有目标，你希望项目最终以什么方式解决问题，能达成什么目标。

背景和目标的阐述，必须要能够自然合理的推导出下一部分内容：项目的核心需求/功能是什么。

如果项目背景，目标的描述不能起到这个作用，那这一节内容就没写好，因为项目方案文档就缺乏了根本的出发点，后续的内容都没有了好坏对错判断的基本依据。

举个例子，如果我想构建一个数据交换服务或ETL系统，那么上述各环节的内容可能是（简化的写）：

背景 ： 当前数据ETL链路极端难用，效率低下，稳定性，维护代价高，用户抱怨多等等。

目标 ： 用户全自助，简单易用；可维护性好；性能高；可靠性好。

核心需求 ： 比如针对“用户全自助，简单易用”这点（其它目标可以类似分析推理），可能是：

提供统一的，标准化的配置后台：用配置的形式表达ETL业务语意，屏蔽下层实现细节。

提供完善的错误反馈信息/机制：让用户能自助解决使用中遇到的问题。

ETL业务流程标准化：将实践沉淀下来，通过配置的方式让用户选择，减少重复工作，降低用户开发的难度，规避使用姿势错误可能造成的问题。

其次，需要对现状和问题进行充分的收集和分析

从方案文档的角度来说，放在这里，是为了进一步细化问题，分析目标，核心需求与当前现状的距在哪里，具体有哪些实际问题需要解决。为后续具体的实现方案，准备必要的输入信息，确定工作的优先级，重要性，项目迭代的步骤等等。

需要强调的是，现状和问题分析，要围绕前面的核心需求的条目展开，两者是强关联的，不要相互脱节，各讲各的

，是输出解决方案

定完需求目标，分析完问题和现状，接下来才是规划具体做什么，怎么做，什么时候做

做什么：

做什么和前面项目目标的要求刚好截然相反，需要输出明确的可执行的事项，而不是模糊的不可执行的要求。

具体做的每一件事情，都要和前面的核心需求和现状问题对应上。如果你发现有些工作，和前面的目标没有任何关联性，那么考虑一下目标是否需要再评估调整，或者这件事情根本就是不重要的。

要做的事项列表，是一个经过归纳思考以后的总结，而不只是一个个零散的事情的随机列表。需要有重点和优先级。如果有必要，以归类，分组等形式结构化的组织相关联的事项。

完整的事项列表，应该是一个和最终目标对应的完整解决方案，而不仅仅只是完成目标工作中的某一个环节。

比如面向用户的终端产品项目，需要包括整个产品的交互逻辑，业务流程的规范设计等等，而不仅仅是对底层系统实现和后台功能点的设计。

这点很多同学也很容易忽略，总觉得功能和架构的实现才是有挑战，需要规划的内容，而产品的形态并没有花心思去琢磨，事后开发前端时才来考虑。实际上后者可能才是真正影响项目成功的关键，也很可能会影响到底层架构的设计和取舍。类比一下，好比一个用户产品都开发完了，才来考虑埋点，数据采集和数据分析的工作，这时候就很被动了。

怎么做：

前期方案文档，没有必要列出详细的技术方案细节，只需要一个整体的技术方向选型和初步的架构设想。但是，如果是涉及到核心需求能否有效满足的关键的技术点，有可能影响整体的架构或产品实现的，那就有必要就可能的方案的进行详细的评估并得出初步的结论。

无关架构或进度安排的方案细节，没有必要写太多，可以后续再补充。

方案中有不明确的地方，即使没有时间调研，也不要简单的略过不写，要在文档中明确的把问题写出来，给出下一步调研的方向等。归根到底，方案文档中，对每一个已知重要的问题，都需要一个明确的结论或者可以后续跟进的，以免事后遗漏。

再强调一下，做什么和怎么做就是手段，既然是手段，就要写得足够具体，具体到有明确的可落地实施的事情，有明确可以衡量的标准，或者针对当前存在的一个具体问题，不要在这个地方又写得像目标，没有明确的可执行的点。

继续举上文数据交换服务的例子，针对其中的一个核心需求：

ETL业务流程标准化：将实践沉淀下来，通过配置的方式让用户选择，减少重复工作，降低用户开发的难度，规避使用姿势错误可能造成的问题。

这个内容要写具体的要做的事项。以下方式来写可能就是不合格的，因为不够具体，还没有足够思考：

总结实践

生成标准的流程

总结常见的错误

以下内容可能就更加明确，更加可落地一些：

统一当前增量数据导入的存储，合并，归档方案

将常见合并，去重逻辑标准化，通过配置自动生成任务脚本

制定ODS快照表生命周期管理方案，规范存储路径和命名方式，定期清理过期数据。

什么时候做，谁来做：

这是做什么和怎么做的进一步延伸，需要强调的是整个项目如何实施的整体步骤，而不仅仅是简单的列一下每项工作的人员和排期，

需要分析系统可能的迭代步骤（包括可能的短期应急和长期解决方案），上下游依赖梳理，需要协同进行的工作，最终项目上线时可能的业务迁移，数据迁移，系统集成等等外围工作的安排。

如果不是工期严格要求，deadline为导向的项目，整体的依赖和步骤往往才是在项目规划阶段需要重点阐述的内容，也是有可能对整体产品的进度，风险产生影响的事项

而具体工作工期的安排，说实话，多数情况下，反到没有那么重要。如果整体工作和步调没考虑周全，工期排得再科学，再精细，也毫无意义。

总结一下，什么时候做什么事，最重要的目的，不在于工期的计算，甚至也不是人力资源的安排，而是为了理顺事情依赖关系，控制可能的意外风险，提升项目开发进度的可控性。

总体原则：

项目方案规划文档的根本目标是统一认识： 明确问题，确定重点，阐明路径，控制风险。

文档的撰写方式，是目标和需求先行，围绕出发点，逐步递进展开。

文档的基本要素： 背景，目标，核心需求，现状问题分析，关键方案难点解析，总体实施路径，工作事项列表，进度安排。

再细化到一些注意事项：

核心需求，必须是核心的,一定要实现的内容！不能缺，也不能滥。

问题现状，工作事项，必须呼应核心需求，要有明确的相关性，不要无的放矢。

围绕最终目标，输出完整的端到端的解决方案，而不是局部环节的方案。需要从最终产品/功能形态的角度考虑要做的事，而不是仅仅考虑底层技术实现。

事项目标列表，不要仅仅罗列要做什么事，更重要的是说明想要得到的结果，而不仅仅是描述实现手段。

所有工作事项，需要明确思考过实施步骤，重要性和优先级，结合目标和需求，进行抽象归纳，而非简单随机罗列。

要有明确的排期，但更重要的是，要完整的分析思考可能的上下游和周边工作依赖。排期只是结果，完整的梳理才是关键。

如何写一份交互说明文档

1、写给谁看 首先需要明确交互说明的读者和在项目中的作用：

视觉设计师：输出视觉稿

前后端开发工程师：代码实现产品设计

测试工程师：写测试用例

产品：项目紧张的情况下，可能会需求和原型设计并行，这时候，交互说明可以协助产品整理并输出需求文档

自己：原型细节自检，优化设计逻辑

2、由谁来写

很明显作为项目的交互设计师是交互说明的主要撰写人和维护者。

在项目进程中，交互说明应由设计师发起，前端开发工程师也会协助修订细节。交互设计师更多的关注点在需求到原型的转化，对于前后端能否实现并不是很确定。前端开发工程师对交互说明的的把关和疑问，能够帮助设计师将设计思想转为工程师能够理解和实现的语言。这样交互说明也能帮助前端开发工程师明确设计实际执行方案。

3、写什么内容

写交互说明文档时，很多人都会疑惑，到底需要写什么呢？我的意见是，站在下游的角度，视觉设计师和开发工程师在需要考虑的与页面相关的逻辑和用户作相关的内容基本都是需要在说明中体现出来。另外我们应该尽量写得详细些，避免研发同事多次来讨论或者直接按照自己的理解直接实现，这样最终的验收效果也会比较好。那么具体的该写什么不该写什么，这里也做了整理供参考。

3.1这些要写

3.1.1页面整体说明模块

页面统一布局：页面整体的排版布局简单说明（比较直观可不写）

相同的交互动作：统一的页面切换方式、手势、弹窗等

相同的处理规则和注意点：比如所有的表格在自适应时的变化规则

3.1.2对象

用户身份和系统功能页面紧密相关。比如后台系统常见的会区分身份，普通还是超级。

3.1.3限制

范围值：比如列表超过10项出现滚动条

极限值：比如某个字段文字超过展示极限值才有缺省，hover气泡展示全部

3.1.4表单校验

表单校验逻辑：是实时校验还是触发按钮后做校验，还是两者结合，表达清楚逻辑并将相关的提示和反馈描述清楚。

3.1.5作与反馈

作：

交互方式：点击、拖动、长按、缩小、放大等

文本框等：获取焦点、失去焦点（比如app键盘的呼出和隐藏）

热区范围：比如卡片展示形式有时将整个卡片作为可触发作的区域

2. 反馈：

提示内容：系统对用户作的及时反馈比如报错提示、失败提示、成功提示等

提示形式：提示的控件样式，比如弹出框是否可关闭等

跳转：跳转形式是当前窗口/新窗口？跳转到哪里？写清楚标号或页面名称 过渡动画：转场方式

3.1.5状态变化

默认：

默认选项选中

默认显示的文案

默认排序方式

正常：

正常场景下的作带来的变化，比如点击表格的表头排序

特殊：

功能特殊，比如两个复选框必须有一个选中

场景特殊，比如无数据情况、加载失败、网络错误

3.1.6其他交互细节

根据项目内容特性和业务将逻辑细节和交互细节表达清楚。比如app可能有锁屏推送，项目是否有数据埋点。

3.2这些不写

商业逻辑，比如：某个功能的实现有怎样的意义，跟产品实现无关的前期准备，就不要画蛇添足了

视觉规范相关，术业有专攻，尊重和相信团队视觉设计师

研发代码的逻辑和规则等，PRD需要解决的问题，不要赘述

4、怎么写

4.1 目录

提供一个参考的目录，可以进行适当的调整作为项目交互原型的目录：

4.2 格式

相比较word等文本记录工具比较Axure，原因有三：

和原型源文件放在一起，方便维护

生成html文件后，研发阅读更方便

熟悉Axure作，能够便捷的添加跳转和动作

4.3 排版布局

根据项目类型和情况确定具体合适的排版，基本可以按照从上到下从左到右的顺序去排版。

web的页面一般比较宽，可以采用先上下，后左右的结构：

上图加标注，下文字说明（左图右文 app的页面比较窄，可以放在原型页面中做说明：

5、怎么做才是不错的交互说明

以上都能理解和做到，已经可以完成一份合格的交互说明文档了。那么怎样才算是一份不错的交互说明的呢？

这里分享几个注意点：

5.1固定的目录结构

对接的下游有时候是同一部门或同一个同事，目录保持基本的统一，可以降低下游的学习成本，另外也让自己在写说明时不必每次都去思考目录的划分。当然，针对不同的产品类型和产品特性需要去调整制订目录。

5.2简洁文字

拒绝流水账式说明，另外当描述文字过长，可能需要重新考虑是否是设计逻辑存在问题。那么如何让说明文字尽可能的简单呢？

流程图代替纯文字说明：流程性强的功能可以尝试这种方式，简单且直接。 表格罗列复杂状态变化

灵活运用开发语言（if/else/case等）

结合动态效果：遇到动画或者效果不太好用语言描述的话，不如直接把动画放在说明页面展示，并结合简单的语言描述。

5.3尽量使用真实、符合逻辑的数据

原型设计的过程中，需要展示数据，对数据的模拟尽可能的真实，撰写交互说明可以将场景还原更加贴近真实可能性。而且，真实符合逻辑的数据，研发也比较能更快理解页面逻辑，所以也可以减少沟通成本。

5.4处理重复内容

原型页面很多内容是复用，那同样的这些重复的内容，按照常见的处理方法，就会重复写很多次的交互说明（相信大家也会粘贴），但是这样带来2个问题，一是研发会不会怀疑前后的交互说明是否有区别，二是如果需要修改的话，需要对所有的相关页面修改，维护的工作量就变大了很多。有2钟解决方法：

写在一处：引用时加链接

写在单独页面，引用时加链接

5.5更新后及时周知

每次更新都是一次改进的过程，添加新内容的同时，保留旧的内容，让其他人也看到走过的弯路，让他们知道每次修改都是深思熟虑后的决定。为什么要周知呢？下图，是不是很直接地解释清楚了：

另外，当我们在项目中写交互说明写多了就会发现，组件可以自己设计生成元件库，调用元件库就可以快捷使用，那么组件的交互说明也可以组件化进行归类入库，在需要的时候直接拿出来根据具体情况调整使用。附上，我整理出的交互说明组件库的部分页面供参考，大家可以根据自己的作习惯和经常接入的项目特点制作一套适合自己的交互说明模板库

6、总结

以上就是我在项目进行过程中发现的问题和个人思考的解决方案。但是，并非所有人都喜欢写说明文档或者看说明文档。有必要的情况下，需要跟团队成员强调交互说明的存在意义，推动大家去阅读和反馈，这样辛辛苦苦写出来的说明才能对项目的发展起到真实的作用。另外在项目合作的过程中，除了做好自己的任务以外，要多站在项目的角度上去思考，要去考虑团队中其他角色尤其是下游伙伴是否能够较好及时地实现或完成相关任务，这样思考后才去决定自己手下急需和应该完成的任务项。

我用的摹客来写交互说明文档，感觉是为产品团队量身打造的文档工具，支持在线撰写或上传本地文档。

文档可以和Mockplus、Axure的原型图和Sketch、Adobe XD、PS的设计稿互相引用，相互论证。也支持自动生成历史版本，可随时追溯和查看。完成后可以直接生成链接分享给同事，同事可以在上面选中文字评论，审阅很方便，哪里有问题也可以随时查看修改。

文档结合设计稿或原型图，可以更加清晰地阐述交互逻辑、设计思路、功能范围、页面细节等等。团队也可以根据产品需求文档清晰了解为什么需要开发这样一款产品。项目的其他相关方也可以随时参阅需求文档，了解项目的基本信息。

前端开发应该如何写技术文档？

一名合格的前端开发工程师，不单单需要掌握前端必须的各种技术，同时还要掌握其它技术，需要掌握一点后台的知识，同时也要对网站构架有一定的了解，这样才可以称之为一个合格的Web前端开发工程师。

如果你想要快速学习Web前端技术，专业全面的学习方式比较好。适合零基础的小白迅速成长，学习曲线先快后慢，也适合有一定基础的学员进阶学习，巩固知识的基础上，稳步进步突破职业瓶颈。

花店前端设计说明书网站规划怎么写

花店前端设计说明书网站规划怎么写。在网站建设之后，网站规划要充分调研网站目标客户、需求、实现和维护的需要和特征，将网站内容详细地表示出来，将网站定位为一个新的、更具体的网站建设，所以网站定位尤为重要。1. 网站建设的目标客户和网站建设的基础网站建设的目标客户就是网站建设的主要目标群体，这一群体的共同特征形成了网站建设的基本目标群体。比如在建站之初首先需要确定目标群体的使用网页功能、作的便捷性等。2. 网站建设的具体目标群体的实际使用的技能、需求、爱好。有的是个性特长，例如想了解一下动漫，会一下子让我们去知道，也会一下子让我们去动态交互的特殊技能，这样更能让我们的学习以及生活更加便利。3. 网站建设的网站实际功能功能。

前端开发怎么写

写前端开发应包含以下步骤：

1、填写基本，如：身高、体重、毕业院校、所学专业等。

2、填写详细的教育经历，如：入学与毕业年份、在校期间职务、暑实习等。

3、填写自我评价，如：本人具有一定基础Internet、网站制作、网站设计、CSS、DIV流程经验，以及网站代码编写等内容。

4、填写，包括手机号码、邮箱等。

5、对进行补充，补充内容包括但不限于期望薪资待遇、期望工作地点等内容。