如何写好技术文档——来自Google十多年的文档经验

【如何写好技术文档——来自Google十多年的文档经验】的更多相关文章

如何写好技术文档——来自Google十多年的文档经验

本文大部分内容翻译总结自<Software Engineering at Google> 第10章节 Documentation. 另外,该书电子版近日已经可以免费下载了 https://abseil.io/resources/swe_at_google.2.pdf,有兴趣的同学可以下载翻阅下. 首先声明,本问所说的文档不仅限于纯文本文档,还包含代码注释(注释也是一种特殊形式的文档). 很多技术人自己非常轻视技术文档的书写,然而又时常抱怨文档不完善.质量差.更新不及时-- 这种在程序猿间普遍存…

Web前端开发规范文档（google规范）

(Xee:其实没什么规范约束,但是养成一种好习惯,何乐而不为?) 区分大小写 xhtml 区分大小写,xhtml要求标签名属性名值都要小写,并且要有双引号和标签闭合. css 元素名称以及id和类名的命名也是区分大小写的(但是属性和值不区分),尽量小写,可以用-连字符,尽量不要用_下划线做连字符(IE6下_和-均失效). javascript 的变量和其他语法元素名都是区分大小写的,变量命名不允许有空格或者其他标点符号,只允许字母.数字.&和_下划线. 综上所述,书写xhtml css…

如何优雅的写UI——（2）MFC下基于CFormView的文档视图程序

在MFC中可以创建多种类型的窗口程序,如对话框程序.单文档结构程序(非文档/视图结构).单文档(文档/视图结构)以及多文档视图结构程序等. 在编写一般的小工具时,我们的首选显然是对话框程序,不过基于对话框的程序不支持视图类,有些功能实现起来会麻烦许多.此时我们可以使用CFormView作为基类来创建单文档(非文档/视图结构)和单文档(文档/视图结构)的程序. 一.使用MFC向导创建程序 (1)单文档(文档/视图结构) (2)不需要状态栏和工具栏 (3)使用CFormView作为基类…

来自 Google 的 R 语言编码风格指南

来自 Google 的 R 语言编码风格指南R 语言是一门主要用于统计计算和绘图的高级编程语言. 这份 R 语言编码风格指南旨在让我们的 R 代码更容易阅读.分享和检查. 以下规则系与 Google 的 R 用户群体协同设计而成. 概要: R编码风格约定文件命名: 以 .R (大写) 结尾标识符命名: variable.name, FunctionName, kConstantName 单行长度: 不超过 80 个字符缩进: 两个空格, 不使用制表符空白花括号: 前括号不折行写, 后括…

什么是API文档？--斯科特·马文

有时候,软件开发人员想要的是自己的软件被其他应用软件所应用,而不是让人来操作.API使各种应用软件互相通信成为了可能. 从事API文档写作15年,我亲眼见证了API产品的崛起.各个公司开始搭建平台,希望别人接入平台并使用平台提供的API.API的发展意味着API文档的增多,这对技术文档工程师无疑是一件好事. 在本文中,我会阐述什么是API,API文档应当包含什么,该类型的AP文档面向哪些读者,以及如何在这个领域快速入门. 什么是API? 有时候,软件开发人员想要让自己的软件被其他应用软件所应用,…

IT软件人员的技术学习内容（写给技术迷茫中的你） - 项目管理系列文章

前面笔者曾经写过一篇关于IT从业者的职业道路文章(见笔者文:IT从业者的职业道路(从程序员到部门经理) - 项目管理系列文章).然后有读者提建议说写写技术方面的路线,所以就有了本文.本文从初学者到思想者的四步方面对IT从业者的技术路线做了阐述(见笔者文:IT从业者的学习规划 - 学习者系列文章开篇),从浅到深的对技术路线需要学习的内容做了叙述,后续会对学习者系列文章进行书写,本文就当做该系列文章的一个版图吧. 对于技术路线,笔者认为,在工作之余,就该自我主动的去学习技术和业务方面的知识.一方面是…