技术文档相关知识
-
技术文档编写心得技术文档编写首先寻找资料,阅读资料可以和编写文档同时进行,即编写段落一时查询段落一的相关资料,当编写到后面的段落时,发现和前面的段落有冲突,在回头整改,整个过程类似于ABSD和螺旋开发模式。第一部分技术文档的开头无外乎背景、目标、范围、参考资料等等,这些是纯商务描述,有成型的资料最好,不然就只能在众多资料阅读后,自己编写。第二部分技术文档编写通常是指系统设计或者系统相关资料,系统的设计与开放的目的自然就是首要位置,其次就是系统的约束,有哪些规则约束的当前系统。最后设计原则或者方法,我们要用什么样的方法去设计系统。第三部分就是系统设计完成状态的展示,展示首先是总体展示,总体展示可细分为很多项,可以根据项目自行选择,如整体用例图、拓扑图、结构图,当然总体系统描述是不可缺少的。之后是主要功能展示,即大项目是子系统或者模块描述,小系统是功能描述。第四部分是决策,该部分并不是必须的,但是,如果当前技术文档是展示重构或者有类似的功能调整或者技术调整或者架构调整时,该部分是必不可少的,决策很简单,只要描述变更点就可以了。
-
Docker最全教程之使用Node.js搭建团队技术文档站(二十三)前言 各种编程语言均有其优势和生态,有兴趣的朋友完全可以涉猎多门语言。在平常的工作之中,也可以尝试选择相对适合的编程语言来完成相关的工作。在团队技术文档站搭建这块,笔者尝试了许多框架,最终还是选择了Hexo,主要是由于其丰富的主题和插件,并且灵活和高度可定制化,改起来也非常方便。我们团队文档站即使用Hexo来构建,并且基于容器配置了完整的代码流水线:docs.xin-lai.com如果对站点配置、主题、插件存在疑问,可以加群沟通。 目录官方镜像 编写一个简单的Web服务器 编码 编写Dockerfile 构建并运行 使用Hexo搭建团队技术文档站 安装 初始化 配置站点信息 生成静态文件 使用hexo-server进行托管 使用容器构建和托管 Node.
-
Android技术文档翻译--工具属性(Tools Attributes)Tools 属性为了在XML文件中记录一些信息,Android专门定义了名为tools的XML命名空间。在应用打包的时候这些信息会被自动去掉,所以不会影响运行和下载的包大小。命名空间的URI是http://schemas.android.com/tools,一般以tools作为前缀:<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools" android:layout_width="match_parent" android:layout_height="match_parent" &
-
程序员如何才能快速高效阅读文档,方法全部都在这里了!!!作者: 极客小俊 一个把逻辑思维转变成代码的技术博主 引言 作为程序员的我们平常阅读技术文档是常有的事情, 也哪怕你不是一个程序猿 不管你身处于哪个行业, 总会有阅读文档文章书籍的时候... 那么什么样的阅读方法才能快速吸取技术文档中的所有知识以及精髓呢? 如何避免低效的看文档呢? 看到后面的内容,就忘了前面的内容应该怎么办? 并且最重要的就是看完文档之后能够快速的应用到项目当中去呢? 这些都是我们看文档的时候需要去考虑的问题! 确定要解决的问题 建立良好的问题需
技术文档相关课程
技术文档相关教程
- 容器技术 在前面的章节里,我们安装了 Linux,也安装了 Docker,接下来是不是该上手 Docker 的使用了呢?先不要着急,通过《Docker简介》的章节介绍,相信我们已经对 Docker 有了初步的了解。但是回想下我们过往的学习经历,每当接触一个新的技术时,总会有一种陌生感,这个感觉主要来源于我们对这门新技术的基础概念没有认知,或者是理解得不够准确。这种陌生感可能会导致两个问题:在学习过程中丧失乐趣和成就感;对将来的深入学习造成障碍。要排除这种陌生感,就一定要把最核心的基础搞明白,心急是吃不了热豆腐的。我们知道 Docker 是一个开源的容器引擎,它的核心是容器技术。那么容器技术到底是什么呢?这一节我们就一起来了解下。
- 1. 容器技术的历史 2000 年,随着 FreeBSD 4.0 的发布,容器技术正式对外公开,这种技术可将 FreeBSD 系统分区为多个子系统,称为 Jail。Jail 是作为安全环境而开发的,Jail 的目的是让进程在经过修改的 chroot 环境中创建,而不会脱离和影响整个系统,在 chroot 环境中,已经对文件系统、网络和用户的访问都实现了虚拟化。2001 年,借助 VServer 项目,容器技术进入了 Linux。这项工作的目的是在高度独立且安全的单一环境中运行多个 Linux 服务器,之后 Linux 容器技术开始逐渐成形。
- 2. 视图技术 最初的 WEB 应用程序,数据直接绑定在 HTML 页面中,页面中的数据不能动态更新。如果要修改页面中的数据,需要手工修改 HTML 页面中的数据,这种页面叫静态页面。所谓的动态网页指页面中的数据能自动更新,页面中可以存在不同类型的变量,随时根据数据库中数据的变化自动变化。HTML 如同一面广告墙,上面贴的什么广告内容,它是不知道的,如果要换广告内容,需要工作人员自己动手。这就是静态网页,现在有很多电子广告牌,广告内容可以自动切换,相当于动态网页。HTML 并不支持变量,所以需要一种视图技术,让 HTML 中支持变量。也可以说是模板技术,在 HTML 中通过嵌入类似于 JAVA 的强逻辑性语言达到数据自动更新的目的。继续讲解之前,深入理解一下视图技术的概念。视图技术: 这是一个抽象概念,或者说是一个概括性概念。任何一款视图技术产品,都应该包括:模板;模板解析引擎。
- 2. 技术选型 本篇我们通过商品浏览项目实例,展现前后端分离项目的开发、测试全流程。技术选型方面,后端毫无疑问选择 Spring Boot ,接口风格采用 RESTful 标准。前端则使用简单的 HTML + Bootstrap + jQuery ,并通过 jQuery 的 $.ajax 方法访问后端接口。
- 3.3 技术栈说明 相信到这里,大家对协议基本上有一个简单的认识了,其实协议并不难,它只是一个约束而已,那么我们如何通过技术的实现,让协议生效呢?主要的核心思想如下:序列化和发序列话技术,这个在 Netty 的编解码的时候已经讲过,序列化可以把对象转化成字节流,反序列化可以把字节流转换成对象;字节容器(字节缓冲区),必须按照协议的字段顺序往字节容器里面存放对应的字节内容,然后把整个容器写到网络当中。这样数据才能按照顺序进行传输,服务端才能按照顺序进行数据的读取和处理。
- 2. 容器技术与虚拟化 容器技术其实是一种基于虚拟化的沙盒技术。沙盒(sandbox)是一种安全机制,为运行中的程序提供隔离环境。通常是作为一些来源不可信、具破坏力或无法判定程序意图的程序提供实验之用。在计算机中,虚拟化是一种资源管理的技术,它将计算机的各种实体资源,如CPU、网络、内存及存储等,进行抽象后展示出来,使用户更方便地使用这些资源。我们举一些常见的例子:平台虚拟化平台虚拟化是针对计算机和操作系统的虚拟化,也就是最常见的一种虚拟化技术,Hyper-V,Virtualbox,VMware 等产品都是应用这类虚拟化技术。资源虚拟化资源虚拟化是指对特定的计算机系统资源的虚拟化,例如对内存、网络资源等等。应用程序虚拟化应用程序虚拟化的一个最典型的应用就是 JAVA,生成的程序在指定的 JVM 虚拟机中运行。那么容器技术属于哪一种虚拟化呢?现在的容器技术,运行在操作系统之上,使用操作系统自身支持的机制(Namespace,CGroup,下面的章节会详细讲解),提供了相对独立的应用程序运行的环境,能够让应用程序间可以互不干扰地独立运行,也提供了资源控制的功能,能对其在运行中所使用的资源进行干预,可以理解为操作系统虚拟化的范畴。
技术文档相关搜索
-
j2ee
j2ee是什么
jar格式
java
java api
java applet
java c
java jdk
java list
java map
java script
java se
java socket
java swing
java switch
java web
java xml
java 程序设计
java 多线程
java 环境变量