一个web项目的文档应该包含哪些部分 一.规范文档1.ui 设计规范2.js.css.html 编码规范3.后台程序编码规范4.文件层级及模块编码规范二.技术架构评审三.运行环境部署细则四.研发流程:0.头脑风暴1.版本定义2.需求分析3.业务流程 4.库表设计5.数据字典6.交互设计 7.界面设计 8.数据协议9.埋点设计10.测试用例 11.代码开发12.测试报告13.验收报告14.访问报告五.发布流程细则 最近翻以前百度空间的笔记返现这篇东西有点无语  ..................…

3 前端渲染和后端渲染 这两种渲染都属于动态页面 区分前后端渲染的关键点是站在浏览器的角度 3.1 后端渲染 浏览器请求服务器后获取到的是完整的HTML页面(即:后台已经组装好HTML文件啦),利用flask模板渲染出来的都是后端渲染 特点: 可维护性不好(前后端开发人员编写的代码有交叉) SEO(即:在百度中容易搜索到)友好,因为页面是完整的,搜索引擎能获取到更多的数据 服务器压力大,服务器需要承担模板渲染的任务 3.2 前端渲染 浏览器请求服务器后获取到的是HTML页面模板和数据,浏览器执行…

当我们发布一个开源项目的时候,最重要的事情之一就是要创建项目文档.对使用项目的用户来说,文档是非常有必要的,通常我们可以使用下面这些方式来创建文档: GitHub Wiki:在 Github 上我们可以为每个项目都创建一个 wiki.Wiki 是由一系列的 Markdown 文件组成,所以我们可以用 wiki 来做项目文档.但这种方案也有一些缺点:wiki 的贡献者不会出现在项目贡献者列表中:文档的结构和布局都是有限制的,只能是 Github Wikis 的样式:文档存储在第三方平台上. REA…

Atitit. 项目文档目录大纲 总集合  v2 -----Atitti.原有项目源码的架构,框架,配置与环境说明 v3 q511 -----Atitit.开发环境 与 工具 以及技术框架 以及 注意事项 v2 .docx 我们推荐的开发理念与工具与技术 -----现有数据库表说明.docx ------功能表v2 q55 - 副本.xlsx 主要对客户需求进行了解析,结构化,归纳整理 -------训练系统需求具体内容  最新版 (1).doc(客户原始需求最新版) ------Atitti.…

Tips 原文作者:Liam Tung  原文地址:Developers rejoice: Microsoft, Google, Mozilla are putting all their web API docs in one place 浏览器厂商已经同意将Mozilla的MDN Web文档作为web API信息的主要存储库. 三家大型浏览器厂商已经同意将他们的跨浏览器文档放到Mozilla开发者网络(MDN)维基百科上. Mozilla的MDN Web文档现在将成为关于Web API和关于…

使用Mkdocs构建你的项目文档 环境搭建 安装必需软件 作者是在windows下安装的,如果是linux或mac用户,官网有更详细的安装说明. windows 10 x64 当然还有广大的windows 7/8 用户,也是适用的. python 3.4 x86版本(必备依赖) 下载地址:https://www.python.org/downloads/release/python-344rc1/ pip(pytone包管理器) 下载地址:https://pypi.python.org/pypi…

简介 安装 我的配置 Chocolatey 简介 - Windows的包管理器 官方网址 安装 注意事项 Python 简介 安装 Pip 简介-Python的包管理器 升级 MkDocs的安装 使用Pip安装MkDocs 检查是否安装正确 MkDocs的使用 初步试用根据官方文档的步骤创建和使用MkDocs 常用命令 My Test 注意事项 简介 类别:项目文档生成器,生成静态站点,管理MarkDown文档. 官方网址:http://www.mkdocs.org/ 中文文档:http://m…

通过vue组件实现跟:Element相似的效果.需要在VuePress网站中将自己的项目中的Vue组件运行结果展示在页面中. 至于如何将组件在VuePress网站中展示请参考:https://segmentfault.com/a/1190000017242116 当项目中的Vue组件的运行结果可以在页面展示以后,接下来就是要将自己的代码展示在Vuepress网站中. 在VuePress网站中展示自己的代码 因为可以在markdown中使用Vue组件,所以可以自己专门写一个Vue组件来写一个效果跟…

VuePress 相关链接 完整的Vue组件代码以及完整的文档,仅适用于个人参考学习: 文档预览地址:预览链接 使用VuePress编辑文档的代码访问:组件文档 完整代码:组件代码 Vue组件开发 这篇文章主要是记录自己在使用VuePress过程中所遇到的问题以及如何一步一步的解决问题. 安装vuepress前,请确保你的 Node.js 版本 >= 8 全局安装 # 安装 yarn global add vuepress 或者:npm install -g vuepress # 新建一个 ma…

Atitit 项目文档规范化与必备文档与推荐文档列表 ===========比较重要的必备文档========== 项目组名单通讯录( 包括项目组,客户沟通人等 需求文档 原型ui文档 开发计划表 项目源码与架构文档以及新结构文档 设计文档 (一般概要即可,重点模块单独详细设计) 数据库文档 注意事项 =========对开发比较重要的文档 Svn源码服务器账号密码 测试数据库账号密码信息 数据库sql脚本文件. 开发环境搭建文档 项目技术规范文档.(项目模式和产品模式有很多不同,需要单独分离)…