网站开发文档撰写,简述HTML文档的结构及其书写规则?

摘要: 大家好,今天小编关注到一个比较有意思的话题,就是关于网站开发文档撰写的问题,于是小编就整理了4个相关介绍网站开发文档撰写的解答,让我们一起看看吧。简述HTML文档的结构及其书写规则...

大家好,今天小编关注到一个比较有意思的话题,就是关于网站开发文档撰写的问题,于是小编就整理了4个相关介绍网站开发文档撰写的解答,让我们一起看看吧。

简述HTML文档的结构及其书写规则?

HTML的基本形式如下;<html><head><title>HTML文件标题<\/title><\/head><body>HTML文件内容<\/body><\/html>HTML文件以<html>开头,以<\/html>结束。主要包括两个部分——头部和主体。常用的HTML标记如下:

①段落标记<p>和<\/p>。

②字体变换标记<font>和<\/font>

③超级链接标记<ahref>和<\/a>。

④插入图片标记<img>。

什么是文档写作?

文档是软件开发使用和维护中的必备资料。软件文档或者源代码文档是指与软件系统及其软件工程过程有关联的文本实体。文档的类型包括软件需求文档,设计文档,测试文档,用户手册等。其中的需求文档,设计文档和测试文档一般是在软件开发过程中由开发者写就的,而用户手册等非过程类文档是由专门的非技术类写作人员写就的。

文档能提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导、帮助、解惑的作用,尤其在维护工作中,文档是不可或缺的资料。

互联网产品的需求文档写作,应该注意哪些事项和规范?

给谁看

在写需求文档之前一定要搞明白给谁看,写的过程中就想象在跟对方分享。

文件格式

以前很多人用word,不过现在么,作为一个互联网人,肯定是用在线文档,各种在线笔记。

版本说明

一般来说需求文档没有一次成型的,都需要经过多个评审会的反复修改,所以版本管理尤为重要。

全局说明

每个人写文档有每个人的习惯,一些简单的交互说明也没有必要每个页面详细描述,所以有必要在一开始做一个全局说明,将整个需求文档中你会简略的,或者一些整体性的功能,比如“权限”、“交互说明”等现行介绍。

功能需求详细,能用图就别用字

因为是文档介绍,所以用词一定要规范和尽可能详尽。毕竟评审需求文档的人不是你肚子里的蛔虫,他不知道你想的是什么,所以每个页面的逻辑关系都需要详细描述。

另外,能用图的就别用字,能把原型图放进去的,就尽可能通过原型图展示。

最后给大家介绍下,其实现在有很多做产品设计的网站提供了标准互联网产品的需求文档写作模板,如下图:

——下图是文档样板具体属于哪个网站我就不在这里说明了,以免有做广告的嫌疑,有需要的同学可以关注我“SaaS起朱楼”,我们私聊沟通——

网站开发文档撰写,简述HTML文档的结构及其书写规则?

如何用Axure来撰写互联网的产品需求文档(PRD)?

Axure作为产品经理必须掌握的基本功,画原型图的工具,但axure不止是能画原型,还可以用来撰写需求文档(PRD)。大多数研发人员并不喜欢长篇大论,对于word文档形式的需求文档,研发人员都是不太待见的,只有某些细节看不懂原型的时候才会去翻看文档的,接下来本文将介绍怎样用Axure做一个详细的需求文档。

一、产品介绍

产品介绍包含产品简介、更新日志以及版本控制。

产品简介包含的内容有产品定位和产品整体战略;更新日志,版本控制;用于记录每一次修改的内容以及当前版本,最近时间更新的内容一定要放在列表最前面方便开发人员打开页面能以最快的速度查看到更改的内容。

网站开发文档撰写,简述HTML文档的结构及其书写规则?

二、业务流程图

业务流程图是对产品整个业务流程进行图形化的展示,对产品整体功能流程的阐释;明确特定的主体都有哪些工作任务以及各个特定主体之间的联系;方便所有人在查看该文档时了解整体的业务背景。

三、产品结构图

产品结构图每个产品的功能逻辑和产品信息的构成图,整体了解的产品结构图,能够对整个产品构成有了大致的轮廓了;产品功能结构图用于描述功能之间的从属关系的图表,能够梳理出每一个模块及其组成的功能点,清晰明了的产品结构图和功能结构对开发人员前期架构设计起到最大限度的帮助。

四、全局说明

在设计原型前的必须要进行整体交互介绍,这些交互主要用于视觉设计师和交互设计师在设计原型图必须要有的规范说明,当然此次的说明是需要设计人员的协调完成的。主要内容包括页面标准、标准色规范、字体规范、按钮/图标规范、系统提示规范、页面状态说明。

网站开发文档撰写,简述HTML文档的结构及其书写规则?


五、原型图及交互说明

这部分主要包含两个内容,一是功能流程图,二是页面分解以及内容说明;

(1)功能流程图

功能流程图对该部分功能进行以图形化显示,当前功能流程的阐释,方便研发人员清楚了解该功能的整体操作步骤。

网站开发文档撰写,简述HTML文档的结构及其书写规则?


(2)页面分解以及内容说明

根据用户场景,将不同的状态进行分析以及内容说明,说明每个细节的实现逻辑,不同情况下的展示样式以及特殊情况说明。

网站开发文档撰写,简述HTML文档的结构及其书写规则?

网站开发文档撰写,简述HTML文档的结构及其书写规则?

网站开发文档撰写,简述HTML文档的结构及其书写规则?

网站开发文档撰写,简述HTML文档的结构及其书写规则?

到这里使用Axure来撰写产品需求文档(PRD)的内容已经完成了,完成这所有内容是需要花很大部分的时间进行整理书写,这也是一种方式来完成需求文档,对研发人员来说直观也实用。因没有添加附件的功能,有需要源文件的同学请在评论里留下你的邮箱,我会找一个时间统一发到你们邮箱。

以上内容若对你有帮助,请点个赞,谢谢^.^

到此,以上就是小编对于网站开发文档撰写的问题就介绍到这了,希望介绍关于网站开发文档撰写的4点解答对大家有用。